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

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

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

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

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

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

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

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

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

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

* [[Management_Console_-_Logging On|Logging On]]
* [[Management_Console_-_General|General]]
** [[Instance Management]]
** [[Instance Administration]]
* [[Management_Console_-_Infrastructure|Infrastructure]]
* Security
** [[Management_Console_-_System_Administrators|System Administrators]]
** [[Management_Console_-_Your_MFA_Settings|Your MFA Settings]]
* [[Management_Console_-_Developer|Developer]]
| style="vertical-align: top; width: 50%" |

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

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

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

== Deployment ==
* [[Client_Deployment|Client Deployment]]
* [[Outlook_Add-in_Deployment|Outlook Add-in Deployment]]
* [[Outlook_App_Deployment|Outlook App Deployment]]

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

Outlook Add-in Deployment

2024-10-08T14:05:29Z

Cstelzmann:

In an Active Directory domain environment, the E-Mail Archive Outlook Add-in can be deployed using group policies (GPOs).
The setup file for the E-Mail Archive Outlook Add-in is stored in the installation directory of MailStore SPE in a ''Setup-<version>'' subfolder. Alternatively, the setup file can be located on the start page of the Client Access Server when accessed without an instance id, e.g. ''<nowiki>https://cas.example.com</nowiki>''.

The ADMX files to configure the Add-in can be found [https://help.mailstore.com/en/spe/images/a/a0/MailStore_ADMX.zip here].

With setup and template file the deployment can be done by following
[https://help.mailstore.com/en/server/MailStore_Outlook_Add-in_Deployment this article].

2022-12-12T10:27:50Z

2021-06-01T12:47:41Z

Cstelzmann: /* settings */

__NOTOC__

== AttachStore ==
Attach existing archive store.

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

=== Argument Values ===

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

== CompactStore ==
Compact archive store.

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

== CreateClientAccessServer ==
Register new client access server.

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

=== Argument Values ===

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

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

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

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

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

== CreateInstance ==
Create new MailStore instance.

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

=== Argument Values ===

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

== CreateInstanceHost ==
Create a new Instance Host.

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

=== Argument Values ===

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

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

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

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

=== Argument Values ===

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

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

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

=== Argument Values ===

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

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

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

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

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

== DeleteInstances ==
Delete one or multiple MailStore Instances

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

=== Argument Values ===

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

== DeleteSystemAdministrator ==
Delete SPE system administrator.

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

== DetachStore ==
Detach archive store

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

== FreezeInstances ==
Freeze a MailStore Instance

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

=== Argument Values ===

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

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

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

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

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

=== Argument Values ===

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

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

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

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

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

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

== GetInstanceConfiguration ==
Get configuration of MailStore Instance.

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

== GetInstanceHosts ==
Get list of Instance Hosts.

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

=== Argument Values ===

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

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

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

== GetInstances ==
Get list of instances.

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

=== Argument Values ===

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

== GetInstanceStatistics ==
Get archive statistics from instance.

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

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

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

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

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

== GetStores ==
Get list of archive stores.

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

== GetSystemAdministrators ==
Get list of system administrators.

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

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

== MergeStore ==
Merge two archive stores.

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

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

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

=== Argument Values ===

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

== Ping ==
Send a keep alive packet.

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

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

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

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

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

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

== RefreshAllStoreStatistics ==
Refresh archive store statistics.

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

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

== RenameStore ==
Rename archive store

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

== RestartInstances ==
Restart one or multiple instances.

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

=== Argument Values ===

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

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

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

== RetryOpenStores ==
Retry opening stores that failed previously

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

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

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

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

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

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

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

=== Argument Values ===

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

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

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

=== Argument Values ===

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

== SetInstanceConfiguration ==
Set configuration of MailStore Instance.

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

=== Argument Values ===

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

== SetInstanceHostConfiguration ==
Set configuration of Instance Host.

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

=== Argument Values ===

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

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

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

=== Argument Values ===

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

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

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

== SetStoreRequestedState ==
Set state of archive store.

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

=== Argument Values ===

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

== SetSystemAdministratorConfiguration ==
Set SPE system administrator configuration.

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

=== Argument Values ===

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

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

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

== SetSystemSmtpConfiguration ==
Set system wide SMTP configuration.

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

=== Argument Values ===

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

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

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

=== Argument Values ===

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

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

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

=== Argument Values ===

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

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

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

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

=== Argument Values ===

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

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

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

== VerifyStore ==
Verify archive stores consistency.

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

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

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

== CancelJobAsync ==
Cancel a running job asynchronously.

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

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

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

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

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

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

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

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

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

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

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

=== Argument Values ===

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

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

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

=== Argument Values ===

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

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

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

== DeleteJob ==
Deletes a job.

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

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

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

== DeleteUser ==
Delete a MailStore user.

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

== GetChildFolders ==
Get child folders.

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

== GetComplianceConfiguration ==
Get current compliance configuration settings.

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

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

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

== GetFolderStatistics ==
Get folder statistics.

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

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

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

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

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

== GetJobs ==
Retrieve list of jobs

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

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

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

== GetSmtpSettings ==
Get current SMTP configuration.

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

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

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

== GetUserInfo ==
Get detailed information about user.

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

== GetUsers ==
Get list of users.

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

== GetWorkerResults ==
Get results of profile executions.

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

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

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

== MoveFolder ==
Move folder.

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

== RenameJob ==
Rename job.

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

== RenameUser ==
Rename a MailStore user.

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

== RunJobAsync ==
Run an existing job.

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

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

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

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

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

=== Argument Values ===

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

== SetComplianceConfiguration ==
Set compliance configuration settings.

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

=== Argument Values ===

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

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

== SetDirectoryServicesConfiguration ==
Set directory services configuration settings.

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

=== Argument Values ===

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

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

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

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

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

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

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

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

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

== SetSmtpSettings ==
Set SMTP configuration.

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

=== Argument Values ===

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

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

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

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

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

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

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

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

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

== SetUserPassword ==
Set password of MailStore user.

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

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

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

== SetUserPrivileges ==
Set privileges of MailStore user.

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

=== Argument Values ===

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

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

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

=== Argument Values ===

==== privileges ====

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

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

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

== TestSmtpSettings ==
Test current SMTP configuration.

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