Difference between revisions of "Management API - Function Reference"

[unchecked revision][unchecked revision]
Line 1: Line 1:
−
= Global Functions =
+
<!-- DO NOT EDIT THIS ARTICLE-->
 +
<!-- The content is generated from get-metadata2mediawiki.py -->
 +
 
 
== AttachStore ==
 
== AttachStore ==
 +
Attach existing archive store.
 +
 
=== Arguments ===
 
=== Arguments ===
 
{| class="wikitable"
 
{| class="wikitable"
 
! width=150px | Name
 
! width=150px | Name
 
! width=120px | Type
 
! width=120px | Type
 +
! Description
 
|-
 
|-
 
| <tt>instanceID</tt>
 
| <tt>instanceID</tt>
−
| string
+
| string  
 +
| Unique ID of MailStore instance in which this command is invoked.
 
|-
 
|-
 
| <tt>name</tt>
 
| <tt>name</tt>
−
| string
+
| string  
 +
| Meaningful name of archive store.
 
|-
 
|-
 
| <tt>path</tt>
 
| <tt>path</tt>
−
| string
+
| string  
 +
| Path of directory containing archive store data.
 
|-
 
|-
 
| <tt>requestedState</tt>
 
| <tt>requestedState</tt>
−
| string ''(optional)''
+
| string (optional)
−
|-
+
| State of archive store after attaching.
 
|}
 
|}
  
−
=== String Definition ===
+
=== Argument Values ===
  
−
{{:Includes:requestedState}}
+
==== 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 ==
 
== CompactStore ==
 +
Compact archive store.
 +
 
=== Arguments ===
 
=== Arguments ===
 
{| class="wikitable"
 
{| class="wikitable"
 
! width=150px | Name
 
! width=150px | Name
 
! width=120px | Type
 
! width=120px | Type
 +
! Description
 
|-
 
|-
 
| <tt>instanceID</tt>
 
| <tt>instanceID</tt>
−
| string
+
| string  
 +
| Unique ID of MailStore instance in which this command is invoked.
 
|-
 
|-
 
| <tt>id</tt>
 
| <tt>id</tt>
−
| number
+
| number  
−
|-
+
| Unique ID of archive store
 
|}
 
|}
  
 
== CreateClientAccessServer ==
 
== CreateClientAccessServer ==
 +
Register new client access server.
 +
 
=== Arguments ===
 
=== Arguments ===
 
{| class="wikitable"
 
{| class="wikitable"
 
! width=150px | Name
 
! width=150px | Name
 
! width=120px | Type
 
! width=120px | Type
 +
! Description
 
|-
 
|-
 
| <tt>config</tt>
 
| <tt>config</tt>
−
| json
+
| json  
−
|-
+
| Configuration of new Client Access Server.
 
|}
 
|}
  
−
=== Config Object Definition ===
+
=== Argument Values ===
  
 +
==== config ====
 
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
 
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
 
{
 
{
−
    "serverName": string,
+
  "serverName" : string,
−
    "port": number,
+
  "port" : number,
−
    "serverCertificate": {
+
  "serverCertificate" : {
−
        "thumbprint": string
+
    "thumbprint" : string
−
    }
+
  }
 
}
 
}
 
</source>
 
</source>
  
 
== CreateClientOneTimeUrlForArchiveAdmin ==
 
== CreateClientOneTimeUrlForArchiveAdmin ==
 +
Create URL including OTP for $archiveadmin access.
 +
 
=== Arguments ===
 
=== Arguments ===
 
{| class="wikitable"
 
{| class="wikitable"
 
! width=150px | Name
 
! width=150px | Name
 
! width=120px | Type
 
! width=120px | Type
 +
! Description
 
|-
 
|-
 
| <tt>instanceID</tt>
 
| <tt>instanceID</tt>
−
| string
+
| string  
 +
| Unique ID of MailStore instance in which this command is invoked.
 
|-
 
|-
 
| <tt>instanceUrl</tt>
 
| <tt>instanceUrl</tt>
−
| string
+
| string (optional)
−
|-
+
| Base URL for accessing instance.
 
|}
 
|}
  
 
== CreateDirectoryOnInstanceHost ==
 
== CreateDirectoryOnInstanceHost ==
 +
Create a directory on an Instance Host
 +
 
=== Arguments ===
 
=== Arguments ===
 
{| class="wikitable"
 
{| class="wikitable"
 
! width=150px | Name
 
! width=150px | Name
 
! width=120px | Type
 
! width=120px | Type
 +
! Description
 
|-
 
|-
 
| <tt>serverName</tt>
 
| <tt>serverName</tt>
−
| string
+
| string  
 +
| Name of Instance Host.
 
|-
 
|-
 
| <tt>path</tt>
 
| <tt>path</tt>
−
| string
+
| string  
−
|-
+
| Path of directory to create.
 
|}
 
|}
  
 
== CreateInstance ==
 
== CreateInstance ==
 +
Create new MailStore instance.
 +
 
=== Arguments ===
 
=== Arguments ===
 
{| class="wikitable"
 
{| class="wikitable"
 
! width=150px | Name
 
! width=150px | Name
 
! width=120px | Type
 
! width=120px | Type
 +
! Description
 
|-
 
|-
 
| <tt>config</tt>
 
| <tt>config</tt>
−
| json
+
| json  
−
|-
+
| Configuration of new instance.
 
|}
 
|}
  
−
=== Config Object Definition ===
+
=== Argument Values ===
  
 +
==== config ====
 
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
 
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
 
{
 
{
−
    "instanceID": string,
+
  "instanceID" : string,
−
    "alias": string,
+
  "alias" : string,
−
    "displayName": string,
+
  "displayName" : string,
−
    "instanceHost": string,
+
  "instanceHost" : string,
−
    "startMode": string,
+
  "startMode" : string,
−
    "baseDirectory" : string
+
  "baseDirectory" : string,
−
    "debugLogEnabled": bool
+
  "debugLogEnabled" : bool,
−
    "vssWriterEnabled": bool
+
  "vssWriterEnabled" : bool
 
}
 
}
 
</source>
 
</source>
  
 
== CreateInstanceHost ==
 
== CreateInstanceHost ==
 +
Create a new Instance Host.
 +
 
=== Arguments ===
 
=== Arguments ===
 
{| class="wikitable"
 
{| class="wikitable"
 
! width=150px | Name
 
! width=150px | Name
 
! width=120px | Type
 
! width=120px | Type
 +
! Description
 
|-
 
|-
 
| <tt>config</tt>
 
| <tt>config</tt>
−
| json
+
| json  
−
|-
+
| Configuration of new Instance Host.
 
|}
 
|}
  
−
=== Config Object Definition ===
+
=== Argument Values ===
  
 +
==== config ====
 
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
 
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
 
{
 
{
−
    "serverName": string,
+
  "serverName" : string,
−
    "port": number,
+
  "port" : number,
−
    "serverCertificate": {
+
  "serverCertificate" : {
−
        "thumbprint": string
+
    "thumbprint" : string
−
    }
+
  }
 
}
 
}
 
</source>
 
</source>
  
 
== CreateLicenseRequest ==
 
== CreateLicenseRequest ==
 +
Create and return data of a license request.
 +
 +
=== Arguments ===
 +
{| class="wikitable"
 +
! width=150px | Name
 +
! width=120px | Type
 +
! Description
 +
|}
  
 
== CreateStore ==
 
== CreateStore ==
 +
Create and attach a new archive store.
 +
 
=== Arguments ===
 
=== Arguments ===
 
{| class="wikitable"
 
{| class="wikitable"
 
! width=150px | Name
 
! width=150px | Name
 
! width=120px | Type
 
! width=120px | Type
 +
! Description
 
|-
 
|-
 
| <tt>instanceID</tt>
 
| <tt>instanceID</tt>
−
| string
+
| string  
 +
| Unique ID of MailStore instance in which this command is invoked.
 
|-
 
|-
 
| <tt>name</tt>
 
| <tt>name</tt>
−
| string
+
| string  
 +
| Meaningful name of archive store.
 
|-
 
|-
 
| <tt>path</tt>
 
| <tt>path</tt>
−
| string
+
| string  
 +
| Path of directory containing archive store data.
 
|-
 
|-
 
| <tt>requestedState</tt>
 
| <tt>requestedState</tt>
−
| string ''(optional)''
+
| string (optional)
−
|-
+
| State of archive store after attaching.
 
|}
 
|}
  
−
=== String Definition ===
+
=== Argument Values ===
  
−
{{:Includes:requestedState}}
+
==== 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 ==
 
== CreateSystemAdministrator ==
 +
Create a new SPE system administrator.
 +
 
=== Arguments ===
 
=== Arguments ===
 
{| class="wikitable"
 
{| class="wikitable"
 
! width=150px | Name
 
! width=150px | Name
 
! width=120px | Type
 
! width=120px | Type
 +
! Description
 
|-
 
|-
 
| <tt>config</tt>
 
| <tt>config</tt>
−
| json
+
| json  
 +
| Configuration of new SPE system administrator.
 
|-
 
|-
 
| <tt>password</tt>
 
| <tt>password</tt>
−
| string
+
| string  
−
|-
+
| Password of new SPE system administrator.
 
|}
 
|}
  
−
=== Config Object Definition ===
+
=== Argument Values ===
  
−
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
+
== DeleteClientAccessServer ==
−
{
+
Delete Client Access Server from management database.
−
    "userName": string
 
−
    "fullName": string,
 
−
}
 
−
</source>
 
  
−
== DeleteClientAccessServer ==
 
 
=== Arguments ===
 
=== Arguments ===
 
{| class="wikitable"
 
{| class="wikitable"
 
! width=150px | Name
 
! width=150px | Name
 
! width=120px | Type
 
! width=120px | Type
 +
! Description
 
|-
 
|-
 
| <tt>serverName</tt>
 
| <tt>serverName</tt>
−
| string
+
| string  
−
|-
+
| Name of Client Access Server.
 
|}
 
|}
  
 
== DeleteInstanceHost ==
 
== DeleteInstanceHost ==
 +
Delete Instance Host from management database.
 +
 
=== Arguments ===
 
=== Arguments ===
 
{| class="wikitable"
 
{| class="wikitable"
 
! width=150px | Name
 
! width=150px | Name
 
! width=120px | Type
 
! width=120px | Type
 +
! Description
 
|-
 
|-
 
| <tt>serverName</tt>
 
| <tt>serverName</tt>
−
| string
+
| string  
−
|-
+
| Name of Instance Host.
 
|}
 
|}
  
 
== DeleteInstances ==
 
== DeleteInstances ==
 +
Delete one or multiple MailStore Instances
 +
 
=== Arguments ===
 
=== Arguments ===
 
{| class="wikitable"
 
{| class="wikitable"
 
! width=150px | Name
 
! width=150px | Name
 
! width=120px | Type
 
! width=120px | Type
 +
! Description
 
|-
 
|-
 
| <tt>instanceFilter</tt>
 
| <tt>instanceFilter</tt>
−
| string
+
| string  
−
|-
+
| Instance filter string.
 
|}
 
|}
  
−
=== String Definition ===
+
=== Argument Values ===
  
−
{{:Includes:instanceFilter}}
+
==== 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 ==
 
== DeleteSystemAdministrator ==
 +
Delete SPE system administrator.
 +
 
=== Arguments ===
 
=== Arguments ===
 
{| class="wikitable"
 
{| class="wikitable"
 
! width=150px | Name
 
! width=150px | Name
 
! width=120px | Type
 
! width=120px | Type
 +
! Description
 
|-
 
|-
 
| <tt>userName</tt>
 
| <tt>userName</tt>
−
| string
+
| string  
−
|-
+
| User name of SPE system administrator.
 
|}
 
|}
  
 
== DetachStore ==
 
== DetachStore ==
 +
Detach archive store
 +
 
=== Arguments ===
 
=== Arguments ===
 
{| class="wikitable"
 
{| class="wikitable"
 
! width=150px | Name
 
! width=150px | Name
 
! width=120px | Type
 
! width=120px | Type
 +
! Description
 
|-
 
|-
 
| <tt>instanceID</tt>
 
| <tt>instanceID</tt>
−
| string
+
| string  
 +
| Unique ID of MailStore instance in which this command is invoked.
 
|-
 
|-
 
| <tt>id</tt>
 
| <tt>id</tt>
−
| number
+
| number  
−
|-
+
| Unique ID of archive store.
 
|}
 
|}
  
 
== FreezeInstances ==
 
== FreezeInstances ==
 +
Freeze a MailStore Instance
 +
 
=== Arguments ===
 
=== Arguments ===
 
{| class="wikitable"
 
{| class="wikitable"
 
! width=150px | Name
 
! width=150px | Name
 
! width=120px | Type
 
! width=120px | Type
 +
! Description
 
|-
 
|-
 
| <tt>instanceFilter</tt>
 
| <tt>instanceFilter</tt>
−
| string
+
| string  
−
|-
+
| Instance filter string.
 
|}
 
|}
  
−
=== String Definition ===
+
=== Argument Values ===
  
−
{{:Includes:instanceFilter}}
+
==== 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 ==
 
== GetArchiveAdminEnabled ==
 +
Get currrent state of archive admin access.
 +
 
=== Arguments ===
 
=== Arguments ===
 
{| class="wikitable"
 
{| class="wikitable"
 
! width=150px | Name
 
! width=150px | Name
 
! width=120px | Type
 
! width=120px | Type
 +
! Description
 
|-
 
|-
 
| <tt>instanceID</tt>
 
| <tt>instanceID</tt>
−
| string
+
| string  
−
|-
+
| Unique ID of MailStore instance in which this command is invoked.
 
|}
 
|}
  
 
== GetClientAccessServers ==
 
== GetClientAccessServers ==
 +
Get list of Client Access Servers.
 +
 
=== Arguments ===
 
=== Arguments ===
 
{| class="wikitable"
 
{| class="wikitable"
 
! width=150px | Name
 
! width=150px | Name
 
! width=120px | Type
 
! width=120px | Type
 +
! Description
 
|-
 
|-
 
| <tt>serverNameFilter</tt>
 
| <tt>serverNameFilter</tt>
−
| string ''(optional)''
+
| string (optional)
 +
| Server name filter string.
 
|-
 
|-
 
| <tt>withServiceStatus</tt>
 
| <tt>withServiceStatus</tt>
−
| bool
+
| bool  
−
|-
+
| Include service status or not.
 
|}
 
|}
  
−
=== String Definitions ===
+
=== Argument Values ===
  
−
{{:Includes:serverNameFilter}}
+
== GetDirectoriesOnInstanceHost ==
 +
Get file system directory structure from Instance Host.
  
−
== GetDirectoriesOnInstanceHost ==
 
 
=== Arguments ===
 
=== Arguments ===
 
{| class="wikitable"
 
{| class="wikitable"
 
! width=150px | Name
 
! width=150px | Name
 
! width=120px | Type
 
! width=120px | Type
 +
! Description
 
|-
 
|-
 
| <tt>serverName</tt>
 
| <tt>serverName</tt>
−
| string
+
| string  
 +
| Name of Instance Host.
 
|-
 
|-
 
| <tt>path</tt>
 
| <tt>path</tt>
−
| string ''(optional)''
+
| string (optional)
−
|-
+
| Path of directory to obtain subdirectories from.
 
|}
 
|}
  
 
== GetEnvironmentInfo ==
 
== GetEnvironmentInfo ==
 +
Return general information about SPE environment.
 +
 
=== Arguments ===
 
=== Arguments ===
 
{| class="wikitable"
 
{| class="wikitable"
 
! width=150px | Name
 
! width=150px | Name
 
! width=120px | Type
 
! width=120px | Type
−
|-
+
! Description
 
|}
 
|}
  
 
== GetIndexConfiguration ==
 
== GetIndexConfiguration ==
 +
Get list of attachment file types to index.
 +
 
=== Arguments ===
 
=== Arguments ===
 
{| class="wikitable"
 
{| class="wikitable"
 
! width=150px | Name
 
! width=150px | Name
 
! width=120px | Type
 
! width=120px | Type
 +
! Description
 
|-
 
|-
 
| <tt>instanceID</tt>
 
| <tt>instanceID</tt>
−
| string
+
| string  
−
|-
+
| Unique ID of MailStore instance in which this command is invoked.
 
|}
 
|}
  
 
== GetInstanceConfiguration ==
 
== GetInstanceConfiguration ==
 +
Get configuration of MailStore Instance.
 +
 
=== Arguments ===
 
=== Arguments ===
 
{| class="wikitable"
 
{| class="wikitable"
 
! width=150px | Name
 
! width=150px | Name
 
! width=120px | Type
 
! width=120px | Type
 +
! Description
 
|-
 
|-
 
| <tt>instanceID</tt>
 
| <tt>instanceID</tt>
−
| string
+
| string  
−
|-
+
| Unique ID of MailStore instance in which this command is invoked.
 
|}
 
|}
  
 
== GetInstanceHosts ==
 
== GetInstanceHosts ==
 +
Get list of Instance Hosts.
 +
 
=== Arguments ===
 
=== Arguments ===
 
{| class="wikitable"
 
{| class="wikitable"
 
! width=150px | Name
 
! width=150px | Name
 
! width=120px | Type
 
! width=120px | Type
 +
! Description
 
|-
 
|-
 
| <tt>serverNameFilter</tt>
 
| <tt>serverNameFilter</tt>
−
| string ''(optional)''
+
| string (optional)
−
|-
+
| Server name filter string.
 
|}
 
|}
  
−
=== String Definitions ===
+
=== Argument Values ===
  
−
{{:Includes:serverNameFilter}}
+
==== serverNameFilter ====
 +
{| class="wikitable"
 +
! width=270px | Name
 +
! Description
 +
|-
 +
| <tt>null</tt>
 +
| All servers
 +
|-
 +
| <tt>serverName</tt>
 +
| Only the given serverName. Must match exactly.
 +
|}
  
 
== GetInstanceProcessLiveStatistics ==
 
== GetInstanceProcessLiveStatistics ==
 +
Get live statistics from instance process.
 +
 
=== Arguments ===
 
=== Arguments ===
 
{| class="wikitable"
 
{| class="wikitable"
 
! width=150px | Name
 
! width=150px | Name
 
! width=120px | Type
 
! width=120px | Type
 +
! Description
 
|-
 
|-
 
| <tt>instanceID</tt>
 
| <tt>instanceID</tt>
−
| string
+
| string  
−
|-
+
| Unique ID of MailStore instance in which this command is invoked.
 
|}
 
|}
  
 
== GetInstances ==
 
== GetInstances ==
 +
Get list of instances.
 +
 
=== Arguments ===
 
=== Arguments ===
 
{| class="wikitable"
 
{| class="wikitable"
 
! width=150px | Name
 
! width=150px | Name
 
! width=120px | Type
 
! width=120px | Type
 +
! Description
 
|-
 
|-
 
| <tt>instanceFilter</tt>
 
| <tt>instanceFilter</tt>
−
| string
+
| string  
−
|-
+
| Instance filter string.
 
|}
 
|}
  
−
=== String Definition ===
+
=== Argument Values ===
  
−
{{:Includes:instanceFilter}}
+
==== 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 ==
 
== GetInstanceStatistics ==
 +
Get archive statistics from instance.
 +
 
=== Arguments ===
 
=== Arguments ===
 
{| class="wikitable"
 
{| class="wikitable"
 
! width=150px | Name
 
! width=150px | Name
 
! width=120px | Type
 
! width=120px | Type
 +
! Description
 
|-
 
|-
 
| <tt>instanceID</tt>
 
| <tt>instanceID</tt>
−
| string
+
| string  
−
|-
+
| Unique ID of MailStore instance in which this command is invoked.
 
|}
 
|}
  
 
== GetServiceStatus ==
 
== GetServiceStatus ==
 +
Get current status of all SPE services.
 +
 +
=== Arguments ===
 +
{| class="wikitable"
 +
! width=150px | Name
 +
! width=120px | Type
 +
! Description
 +
|}
  
 
== GetStoreAutoCreateConfiguration ==
 
== GetStoreAutoCreateConfiguration ==
 +
Get automatic archive store creation settings.
 +
 
=== Arguments ===
 
=== Arguments ===
 
{| class="wikitable"
 
{| class="wikitable"
 
! width=150px | Name
 
! width=150px | Name
 
! width=120px | Type
 
! width=120px | Type
 +
! Description
 
|-
 
|-
 
| <tt>instanceID</tt>
 
| <tt>instanceID</tt>
−
| string
+
| string  
−
|-
+
| Unique ID of MailStore instance in which this command is invoked.
 
|}
 
|}
  
 
== GetStores ==
 
== GetStores ==
 +
Get list of archive stores.
 +
 
=== Arguments ===
 
=== Arguments ===
 
{| class="wikitable"
 
{| class="wikitable"
 
! width=150px | Name
 
! width=150px | Name
 
! width=120px | Type
 
! width=120px | Type
 +
! Description
 
|-
 
|-
 
| <tt>instanceID</tt>
 
| <tt>instanceID</tt>
−
| string
+
| string  
−
|-
+
| Unique ID of MailStore instance in which this command is invoked.
 
|}
 
|}
  
 
== GetSystemAdministrators ==
 
== GetSystemAdministrators ==
 +
Get list of system administrators.
 +
 +
=== Arguments ===
 +
{| class="wikitable"
 +
! width=150px | Name
 +
! width=120px | Type
 +
! Description
 +
|}
  
 
== MaintainFileSystemDatabases ==
 
== 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 ===
 
=== Arguments ===
 
{| class="wikitable"
 
{| class="wikitable"
 
! width=150px | Name
 
! width=150px | Name
 
! width=120px | Type
 
! width=120px | Type
 +
! Description
 
|-
 
|-
 
| <tt>instanceID</tt>
 
| <tt>instanceID</tt>
−
| string
+
| 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 ==
 
== PairWithManagementServer ==
 +
Pair server role with Management Server.
 +
 
=== Arguments ===
 
=== Arguments ===
 
{| class="wikitable"
 
{| class="wikitable"
 
! width=150px | Name
 
! width=150px | Name
 
! width=120px | Type
 
! width=120px | Type
 +
! Description
 
|-
 
|-
−
| <tt>[[#serverType|serverType]]</tt>
+
| <tt>serverType</tt>
−
| string
+
| string  
 +
| Type of server role.
 
|-
 
|-
 
| <tt>serverName</tt>
 
| <tt>serverName</tt>
−
| string
+
| string  
 +
| Name of server that hosts 'serverType' role.
 
|-
 
|-
 
| <tt>port</tt>
 
| <tt>port</tt>
−
| number
+
| number  
 +
| TCP port on which 'serverType' role on 'serverName' accepts connections.
 
|-
 
|-
 
| <tt>thumbprint</tt>
 
| <tt>thumbprint</tt>
−
| string
+
| string  
−
|-
+
| Thumbprint of SSL certificate used by serverType' role on 'serverName'
 
|}
 
|}
 +
 +
=== Argument Values ===
  
 
== Ping ==
 
== Ping ==
 +
Send a keep alive packet.
 +
 +
=== Arguments ===
 +
{| class="wikitable"
 +
! width=150px | Name
 +
! width=120px | Type
 +
! Description
 +
|}
  
 
== RebuildSelectedStoreIndexes ==
 
== RebuildSelectedStoreIndexes ==
 +
Rebuild search indexes of selected archive stores.
 +
 
=== Arguments ===
 
=== Arguments ===
 
{| class="wikitable"
 
{| class="wikitable"
 
! width=150px | Name
 
! width=150px | Name
 
! width=120px | Type
 
! width=120px | Type
 +
! Description
 
|-
 
|-
 
| <tt>instanceID</tt>
 
| <tt>instanceID</tt>
−
| string
+
| string  
−
|-
+
| Unique ID of MailStore instance in which this command is invoked.
 
|}
 
|}
  
 
== RefreshAllStoreStatistics ==
 
== RefreshAllStoreStatistics ==
 +
Refresh archive store statistics.
 +
 
=== Arguments ===
 
=== Arguments ===
 
{| class="wikitable"
 
{| class="wikitable"
 
! width=150px | Name
 
! width=150px | Name
 
! width=120px | Type
 
! width=120px | Type
 +
! Description
 
|-
 
|-
 
| <tt>instanceID</tt>
 
| <tt>instanceID</tt>
−
| string
+
| string  
−
|-
+
| Unique ID of MailStore instance in which this command is invoked.
 
|}
 
|}
  
 
== RenameStore ==
 
== RenameStore ==
 +
Rename archvive store
 +
 
=== Arguments ===
 
=== Arguments ===
 
{| class="wikitable"
 
{| class="wikitable"
 
! width=150px | Name
 
! width=150px | Name
 
! width=120px | Type
 
! width=120px | Type
 +
! Description
 
|-
 
|-
 
| <tt>instanceID</tt>
 
| <tt>instanceID</tt>
−
| string
+
| string  
 +
| Unique ID of MailStore instance in which this command is invoked.
 
|-
 
|-
 
| <tt>id</tt>
 
| <tt>id</tt>
−
| number
+
| number  
 +
| Unique ID of archive store.
 
|-
 
|-
 
| <tt>name</tt>
 
| <tt>name</tt>
−
| string
+
| string  
−
|-
+
| New name of archive store.
 
|}
 
|}
  
 
== RestartInstances ==
 
== RestartInstances ==
 +
Restart one or multiple instances.
 +
 
=== Arguments ===
 
=== Arguments ===
 
{| class="wikitable"
 
{| class="wikitable"
 
! width=150px | Name
 
! width=150px | Name
 
! width=120px | Type
 
! width=120px | Type
 +
! Description
 
|-
 
|-
 
| <tt>instanceFilter</tt>
 
| <tt>instanceFilter</tt>
−
| string
+
| string  
−
|-
+
| Instance filter string.
 
|}
 
|}
  
−
=== String Definition ===
+
=== Argument Values ===
  
−
{{:Includes:instanceFilter}}
+
==== instanceFilter ====
 +
{| class="wikitable"
 +
! width=270px | Name
 +
! Description
 +
|-
 +
| <tt>*</tt>
 +
| All instances
 +
|-
 +
| <tt>instance01 instance02 instance03</tt>
 +
| instance01, instance02 and instance03
 +
|-
 +
| <tt>*instancehost01 *instancehost02</tt>
 +
| All instances on instancehost1 and instancehost2
 +
|-
 +
| <tt>* .running</tt>
 +
| All running instances
 +
|-
 +
| <tt>* .stopped</tt>
 +
| All stopped instances
 +
|}
  
 
== RetryOpenStores ==
 
== RetryOpenStores ==
 +
Retry opening stores that failed previously
 +
 
=== Arguments ===
 
=== Arguments ===
 
{| class="wikitable"
 
{| class="wikitable"
 
! width=150px | Name
 
! width=150px | Name
 
! width=120px | Type
 
! width=120px | Type
 +
! Description
 
|-
 
|-
 
| <tt>instanceID</tt>
 
| <tt>instanceID</tt>
−
| string
+
| string  
−
|-
+
| Unique ID of MailStore instance in which this command is invoked.
 
|}
 
|}
  
 
== SelectAllStoreIndexesForRebuild ==
 
== SelectAllStoreIndexesForRebuild ==
 +
Select all archive store for rebuild.
 +
 
=== Arguments ===
 
=== Arguments ===
 
{| class="wikitable"
 
{| class="wikitable"
 
! width=150px | Name
 
! width=150px | Name
 
! width=120px | Type
 
! width=120px | Type
 +
! Description
 
|-
 
|-
 
| <tt>instanceID</tt>
 
| <tt>instanceID</tt>
−
| string
+
| string  
−
|-
+
| Unique ID of MailStore instance in which this command is invoked.
 
|}
 
|}
  
 
== SetArchiveAdminEnabled ==
 
== SetArchiveAdminEnabled ==
 +
Enable or disable archive admin access.
 +
 
=== Arguments ===
 
=== Arguments ===
 
{| class="wikitable"
 
{| class="wikitable"
 
! width=150px | Name
 
! width=150px | Name
 
! width=120px | Type
 
! width=120px | Type
 +
! Description
 
|-
 
|-
 
| <tt>instanceID</tt>
 
| <tt>instanceID</tt>
−
| string
+
| string  
 +
| Unique ID of MailStore instance in which this command is invoked.
 
|-
 
|-
 
| <tt>enabled</tt>
 
| <tt>enabled</tt>
−
| bool
+
| bool  
−
|-
+
| Enable or disable flag.
 
|}
 
|}
  
−
== SetComplianceConfiguration ==
+
== SetClientAccessServerConfiguration ==
 +
Set the configuration of a Client Access Server.
 +
 
 
=== Arguments ===
 
=== Arguments ===
 
{| class="wikitable"
 
{| class="wikitable"
 
! width=150px | Name
 
! width=150px | Name
 
! width=120px | Type
 
! width=120px | Type
−
|-
+
! Description
−
| <tt>instanceID</tt>
 
−
| string
 
 
|-
 
|-
 
| <tt>config</tt>
 
| <tt>config</tt>
−
| json
+
| json  
−
|-
+
| Client Access Server configuration.
 
|}
 
|}
  
−
=== Config Object Definition ===
+
=== Argument Values ===
 +
 
 +
==== config ====
 
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
 
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
 
{
 
{
−
    "adminEmailPreviewEnabled": bool,
+
  "serverName" : string,
−
    "globalRetentionTimeYears": number,
+
  "port" : number,
−
    "legalHoldEnabled": bool,
+
  "serverCertificate" : {
−
     "logSuccessfulUserActivities": array
+
     "thumbprint" : string
 +
  }
 
}
 
}
 
</source>
 
</source>
  
−
Allowed values of ''logSuccessfulUserActivities'' array items are equal to the ''User Activity'' names at ''MailStore Client'' > ''Administrative Tools'' > ''Compliance'' > ''Auditing''.
+
== SetIndexConfiguration ==
 +
Set full text search index configuration.
  
−
== SetDirectoryServicesConfiguration ==
 
 
=== Arguments ===
 
=== Arguments ===
 
{| class="wikitable"
 
{| class="wikitable"
 
! width=150px | Name
 
! width=150px | Name
 
! width=120px | Type
 
! width=120px | Type
 +
! Description
 
|-
 
|-
 
| <tt>instanceID</tt>
 
| <tt>instanceID</tt>
−
| string
+
| string  
 +
| Unique ID of MailStore instance in which this command is invoked.
 
|-
 
|-
 
| <tt>config</tt>
 
| <tt>config</tt>
−
| json
+
| json  
−
|-
+
| Full text search index configuration.
 
|}
 
|}
  
−
=== Config Object Definition ===
+
=== Argument Values ===
 +
 
 +
==== config ====
 +
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
 +
UseGetIndexConfigurationtoreveivesupportedvalue.
 +
</source>
  
−
Use [[#GetDirectoryServicesConfiguration|GetDirectoryServicesConfiguration]]  command after manual directory service configuration to retrieve the config object definition.
+
== SetInstanceConfiguration ==
 +
Set configuration of MailStore Instance.
  
−
== SetIndexConfiguration ==
 
 
=== Arguments ===
 
=== Arguments ===
 
{| class="wikitable"
 
{| class="wikitable"
 
! width=150px | Name
 
! width=150px | Name
 
! width=120px | Type
 
! width=120px | Type
−
|-
+
! Description
−
| <tt>instanceID</tt>
 
−
| string
 
 
|-
 
|-
 
| <tt>config</tt>
 
| <tt>config</tt>
−
| json
+
| json  
−
|-
+
| Instance configuration.
 
|}
 
|}
  
−
=== Config Object Definition ===
+
=== Argument Values ===
  
 +
==== config ====
 
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
 
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
 
{
 
{
−
    "attachmentExtensions": string
+
  "instanceID" : string,
 +
  "alias" : string,
 +
  "displayName" : string,
 +
  "instanceHost" : string,
 +
  "startMode" : string,
 +
  "baseDirectory" : string,
 +
  "debugLogEnabled" : bool,
 +
  "vssWriterEnabled" : bool
 
}
 
}
 
</source>
 
</source>
  
−
== SetInstanceConfiguration ==
+
== SetInstanceHostConfiguration ==
 +
Set configuration of Instance Host.
 +
 
 
=== Arguments ===
 
=== Arguments ===
 
{| class="wikitable"
 
{| class="wikitable"
 
! width=150px | Name
 
! width=150px | Name
 
! width=120px | Type
 
! width=120px | Type
 +
! Description
 
|-
 
|-
 
| <tt>config</tt>
 
| <tt>config</tt>
−
| json
+
| json  
−
|-
+
| Instance Host configuration.
 
|}
 
|}
  
−
=== Config Object Definition ===
+
=== Argument Values ===
  
 +
==== config ====
 
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
 
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
 
{
 
{
−
    "instanceID": string,
+
  "serverName" : string,
−
    "alias": string,
+
  "port" : number,
−
    "displayName": string,
+
  "serverCertificate" : {
−
     "instanceHost": string,
+
     "thumbprint" : string
−
    "startMode": string,
+
  },
−
    "baseDirectory": string,
+
  "baseDirectory" : string
−
    "debugLogEnabled": bool,
 
−
    "vssWriterEnabled": bool
 
 
}
 
}
 
</source>
 
</source>
  
 
== SetStoreAutoCreateConfiguration ==
 
== SetStoreAutoCreateConfiguration ==
 +
Set configuration for automatic archive store creation.
 +
 
=== Arguments ===
 
=== Arguments ===
 
{| class="wikitable"
 
{| class="wikitable"
 
! width=150px | Name
 
! width=150px | Name
 
! width=120px | Type
 
! width=120px | Type
 +
! Description
 
|-
 
|-
 
| <tt>instanceID</tt>
 
| <tt>instanceID</tt>
−
| string
+
| string  
 +
| Unique ID of MailStore instance in which this command is invoked.
 
|-
 
|-
 
| <tt>config</tt>
 
| <tt>config</tt>
−
| json
+
| json  
−
|-
+
| Archive store automatic creation configuration.
 
|}
 
|}
  
−
=== Config Object Definition ===
+
=== Argument Values ===
  
 +
==== config ====
 
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
 
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
 
{
 
{
−
    "enabled": bool,
+
  "enabled" : bool,
−
    "interval": string,
+
  "interval" : string,
−
    "sizeThreshold": string,
+
  "sizeThreshold" : string,
−
    "numberOfMessagesThreshold": number,
+
  "numberOfMessagesThreshold" : number,
−
    "baseDirectory": string
+
  "baseDirectory" : string
 
}
 
}
 
</source>
 
</source>
  
 
== SetStorePath ==
 
== SetStorePath ==
 +
Set the path to archive store data.
 +
 
=== Arguments ===
 
=== Arguments ===
 
{| class="wikitable"
 
{| class="wikitable"
 
! width=150px | Name
 
! width=150px | Name
 
! width=120px | Type
 
! width=120px | Type
 +
! Description
 
|-
 
|-
 
| <tt>instanceID</tt>
 
| <tt>instanceID</tt>
−
| string
+
| string  
 +
| Unique ID of MailStore instance in which this command is invoked.
 
|-
 
|-
 
| <tt>id</tt>
 
| <tt>id</tt>
−
| number
+
| number  
 +
| Unique ID of archive store.
 
|-
 
|-
 
| <tt>path</tt>
 
| <tt>path</tt>
−
| string
+
| string  
−
|-
+
| Path to archvie store data.
 
|}
 
|}
  
 
== SetStoreRequestedState ==
 
== SetStoreRequestedState ==
 +
Set state of archive store.
 +
 
=== Arguments ===
 
=== Arguments ===
 
{| class="wikitable"
 
{| class="wikitable"
 
! width=150px | Name
 
! width=150px | Name
 
! width=120px | Type
 
! width=120px | Type
 +
! Description
 
|-
 
|-
 
| <tt>instanceID</tt>
 
| <tt>instanceID</tt>
−
| string
+
| string  
 +
| Unique ID of MailStore instance in which this command is invoked.
 
|-
 
|-
 
| <tt>id</tt>
 
| <tt>id</tt>
−
| number
+
| number  
 +
| Unique ID of archive store.
 
|-
 
|-
 
| <tt>requestedState</tt>
 
| <tt>requestedState</tt>
−
| string
+
| string  
−
|-
+
| State of archive store.
 
|}
 
|}
  
−
=== String Definition ===
+
=== Argument Values ===
−
 
 
−
{{:Includes:requestedState}}
 
  
−
== SetSystemAdministratorPassword ==
+
==== requestedState ====
−
=== Arguments ===
 
 
{| class="wikitable"
 
{| class="wikitable"
−
! width=150px | Name
+
! width=270px | Name
−
! width=120px | Type
+
! Description
 +
|-
 +
| <tt>current</tt>
 +
| Same as Normal but new messages will be archived in the archive store that is set to Current.
 
|-
 
|-
−
| <tt>userName</tt>
+
| <tt>normal</tt>
−
| string
+
| The content of archives store is available to users and can be modified if the user has the appropriate permission.
 
|-
 
|-
−
| <tt>password</tt>
+
| <tt>writeProtected</tt>
−
| string
+
| 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.
 
|}
 
|}
  
−
== StartInstances ==
+
== SetSystemAdministratorConfiguration ==
 +
Set SPE system adminstrator configuration.
 +
 
 
=== Arguments ===
 
=== Arguments ===
 
{| class="wikitable"
 
{| class="wikitable"
 
! width=150px | Name
 
! width=150px | Name
 
! width=120px | Type
 
! width=120px | Type
 +
! Description
 
|-
 
|-
−
| <tt>instanceFilter</tt>
+
| <tt>config</tt>
−
| string
+
| json
−
|-
+
| SPE system adminstrator configuration.
 
|}
 
|}
  
−
=== String Definition ===
+
=== Argument Values ===
  
−
{{:Includes:instanceFilter}}
+
==== config ====
 +
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
 +
{
 +
  "fullName" : string
 +
}
 +
</source>
 +
 
 +
== SetSystemAdministratorPassword ==
 +
Set password for SPE system administrator.
  
−
== StopInstances ==
 
 
=== Arguments ===
 
=== Arguments ===
 
{| class="wikitable"
 
{| class="wikitable"
 
! width=150px | Name
 
! width=150px | Name
 
! width=120px | Type
 
! width=120px | Type
 +
! Description
 
|-
 
|-
−
| <tt>instanceFilter</tt>
+
| <tt>userName</tt>
−
| string
+
| string  
 +
| User name of SPE system administrator.
 
|-
 
|-
 +
| <tt>password</tt>
 +
| string
 +
| New password for SPE system administrator.
 
|}
 
|}
  
−
=== String Definition ===
+
== StartInstances ==
−
 
+
Start one or multiple MailStore Instances.
−
{{:Includes:instanceFilter}}
 
  
−
== ThawInstances ==
 
 
=== Arguments ===
 
=== Arguments ===
 
{| class="wikitable"
 
{| class="wikitable"
 
! width=150px | Name
 
! width=150px | Name
 
! width=120px | Type
 
! width=120px | Type
 +
! Description
 
|-
 
|-
 
| <tt>instanceFilter</tt>
 
| <tt>instanceFilter</tt>
−
| string
+
| string  
−
|-
+
| Instance filter string.
 
|}
 
|}
  
−
=== String Definition ===
+
=== Argument Values ===
−
 
 
−
{{:Includes:instanceFilter}}
 
  
−
== UpdateClientAccessServerConfiguration ==
+
==== instanceFilter ====
−
=== Arguments ===
 
 
{| class="wikitable"
 
{| class="wikitable"
−
! width=150px | Name
+
! width=270px | Name
−
! width=120px | Type
+
! 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>config</tt>
+
| <tt>* .running</tt>
−
| json
+
| All running instances
 
|-
 
|-
 +
| <tt>* .stopped</tt>
 +
| All stopped instances
 
|}
 
|}
  
−
=== Config Object Definition ===
+
== StopInstances ==
−
 
+
Stop one or multiple MailStore Instances.
−
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
 
−
{
 
−
    "serverName": string,
 
−
    "port": number,
 
−
    "serverCertificate": {
 
−
        "thumbprint": string
 
−
    }
 
−
}
 
−
</source>
 
  
−
== UpdateInstanceHostConfiguration ==
 
 
=== Arguments ===
 
=== Arguments ===
 
{| class="wikitable"
 
{| class="wikitable"
 
! width=150px | Name
 
! width=150px | Name
 
! width=120px | Type
 
! width=120px | Type
 +
! Description
 
|-
 
|-
−
| <tt>config</tt>
+
| <tt>instanceFilter</tt>
−
| json
+
| string
−
|-
+
| Instance filter string.
 
|}
 
|}
  
 +
=== Argument Values ===
  
−
=== Config Object Definition ===
+
==== 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
 +
|}
  
−
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
+
== ThawInstances ==
−
{
+
Thaw one or multiple MailStore Instances.
−
    "serverName": string,
 
−
    "port": number,
 
−
    "serverCertificate": {
 
−
        "thumbprint": string
 
−
    }
 
−
    "baseDirectory": string
 
−
}
 
−
</source>
 
  
−
== UpdateSystemAdministratorConfiguration ==
 
 
=== Arguments ===
 
=== Arguments ===
 
{| class="wikitable"
 
{| class="wikitable"
 
! width=150px | Name
 
! width=150px | Name
 
! width=120px | Type
 
! width=120px | Type
 +
! Description
 
|-
 
|-
−
| <tt>config</tt>
+
| <tt>instanceFilter</tt>
−
| json
+
| string
−
|-
+
| Instance filter string.
 
|}
 
|}
  
 +
=== Argument Values ===
  
−
=== Config Object Definition ===
+
==== 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
 +
|}
  
−
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
+
== UpgradeStore ==
−
{
+
Upgrade archive store from MailStore Server 5 or older to current format.
−
    "fullName": string,
 
−
    "passwordHash": string
 
−
}
 
−
</source>
 
  
−
== UpgradeStore ==
 
 
=== Arguments ===
 
=== Arguments ===
 
{| class="wikitable"
 
{| class="wikitable"
 
! width=150px | Name
 
! width=150px | Name
 
! width=120px | Type
 
! width=120px | Type
 +
! Description
 
|-
 
|-
 
| <tt>instanceID</tt>
 
| <tt>instanceID</tt>
−
| string
+
| string  
 +
| Unique ID of MailStore instance in which this command is invoked.
 
|-
 
|-
 
| <tt>id</tt>
 
| <tt>id</tt>
−
| number
+
| number  
−
|-
+
| Unique ID of archive store.
 
|}
 
|}
  
 
== VerifyStore ==
 
== VerifyStore ==
 +
Verify archive stores consistency.
 +
 
=== Arguments ===
 
=== Arguments ===
 
{| class="wikitable"
 
{| class="wikitable"
 
! width=150px | Name
 
! width=150px | Name
 
! width=120px | Type
 
! width=120px | Type
 +
! Description
 
|-
 
|-
 
| <tt>instanceID</tt>
 
| <tt>instanceID</tt>
−
| string
+
| string  
 +
| Unique ID of MailStore instance in which this command is invoked.
 
|-
 
|-
 
| <tt>id</tt>
 
| <tt>id</tt>
−
| number
+
| number  
−
|-
+
| Unique ID of archive store.
 
|}
 
|}
  
−
= Instance Level Functions =
+
== ClearUserPrivilegesOnFolders ==
 +
Removes all privileges of a user on all archive folders.
  
−
'''Important Notice: ''' In order to be able to call functions on instance level, the ''Service Provider Access'' must be enabled as described in [[Instance_Management_-_Instance_Administration#Archive_Access|Archive Access]] first.
 
−
 
−
== ClearUserPrivilegesOnFolders ==
 
 
=== Arguments ===
 
=== Arguments ===
 
{| class="wikitable"
 
{| class="wikitable"
 
! width=150px | Name
 
! width=150px | Name
 
! width=120px | Type
 
! width=120px | Type
 +
! Description
 
|-
 
|-
 
| <tt>instanceID</tt>
 
| <tt>instanceID</tt>
−
| string
+
| string  
 +
| Unique ID of MailStore instance in which this command is invoked.
 
|-
 
|-
 
| <tt>userName</tt>
 
| <tt>userName</tt>
−
| string
+
| string  
−
|-
+
| User name of MailStore user.
 
|}
 
|}
  
 
== CreateProfile ==
 
== CreateProfile ==
 +
Create a new archiving or exporting profile.
 +
 
=== Arguments ===
 
=== Arguments ===
 
{| class="wikitable"
 
{| class="wikitable"
 
! width=150px | Name
 
! width=150px | Name
 
! width=120px | Type
 
! width=120px | Type
 +
! Description
 
|-
 
|-
 
| <tt>instanceID</tt>
 
| <tt>instanceID</tt>
−
| string
+
| string  
 +
| Unique ID of MailStore instance in which this command is invoked.
 
|-
 
|-
 
| <tt>properties</tt>
 
| <tt>properties</tt>
−
| json
+
| json  
 +
| Profile properties.
 
|-
 
|-
 
| <tt>raw</tt>
 
| <tt>raw</tt>
−
| bool
+
| bool  
−
|-
+
| Currently only 'true' is supported.
 
|}
 
|}
  
−
=== Properties Object Definition ===
+
=== Argument Values ===
  
−
To receive available profile properties create a profile of the desired type manually and use the [[#GetProfiles|GetProfiles]] function.
+
== CreateUser ==
 +
Create new MailStore user.
  
−
== CreateUser ==
 
 
=== Arguments ===
 
=== Arguments ===
 
{| class="wikitable"
 
{| class="wikitable"
 
! width=150px | Name
 
! width=150px | Name
 
! width=120px | Type
 
! width=120px | Type
 +
! Description
 
|-
 
|-
 
| <tt>instanceID</tt>
 
| <tt>instanceID</tt>
−
| string
+
| string  
 +
| Unique ID of MailStore instance in which this command is invoked.
 
|-
 
|-
 
| <tt>userName</tt>
 
| <tt>userName</tt>
−
| string
+
| string  
 +
| User name of new MailStore user.
 
|-
 
|-
 
| <tt>privileges</tt>
 
| <tt>privileges</tt>
−
| string
+
| string  
 +
| Comma separated list of privileges.
 
|-
 
|-
 
| <tt>fullName</tt>
 
| <tt>fullName</tt>
−
| string ''(optional)''
+
| string (optional)
 +
| Full name of user.
 
|-
 
|-
 
| <tt>distinguishedName</tt>
 
| <tt>distinguishedName</tt>
−
| string ''(optional)''
+
| string (optional)
 +
| LDAP DN string.
 
|-
 
|-
 
| <tt>authentication</tt>
 
| <tt>authentication</tt>
−
| string ''(optional)''
+
| string (optional)
 +
| Authentication setting for user: 'Standard' or 'DirectoryService'.
 
|-
 
|-
 
| <tt>password</tt>
 
| <tt>password</tt>
−
| string ''(optional)''
+
| string (optional)
−
|-
+
| Password of new user.
 
|}
 
|}
  
 
== DeleteEmptyFolders ==
 
== DeleteEmptyFolders ==
 +
Remove folders from folder tree that do not contain emails.
 +
 
=== Arguments ===
 
=== Arguments ===
 
{| class="wikitable"
 
{| class="wikitable"
 
! width=150px | Name
 
! width=150px | Name
 
! width=120px | Type
 
! width=120px | Type
 +
! Description
 
|-
 
|-
 
| <tt>instanceID</tt>
 
| <tt>instanceID</tt>
−
| string
+
| string  
 +
| Unique ID of MailStore instance in which this command is invoked.
 
|-
 
|-
 
| <tt>folder</tt>
 
| <tt>folder</tt>
−
| string ''(optional)''
+
| string (optional)
 +
| Entry point in folder tree.
 +
|}
 +
 
 +
== DeleteMessage ==
 +
Delete a single message
 +
 
 +
=== Arguments ===
 +
{| class="wikitable"
 +
! width=150px | Name
 +
! width=120px | Type
 +
! Description
 
|-
 
|-
 +
| <tt>instanceID</tt>
 +
| string
 +
| Unique ID of MailStore instance in which this command is invoked.
 +
|-
 +
| <tt>id</tt>
 +
| string (optional)
 +
| Unique ID of message. Format: <store_id>:<message_num>
 
|}
 
|}
  
 
== DeleteProfile ==
 
== DeleteProfile ==
 +
Delete an archiving or exporting profile.
 +
 
=== Arguments ===
 
=== Arguments ===
 
{| class="wikitable"
 
{| class="wikitable"
 
! width=150px | Name
 
! width=150px | Name
 
! width=120px | Type
 
! width=120px | Type
 +
! Description
 
|-
 
|-
 
| <tt>instanceID</tt>
 
| <tt>instanceID</tt>
−
| string
+
| string  
 +
| Unique ID of MailStore instance in which this command is invoked.
 
|-
 
|-
 
| <tt>id</tt>
 
| <tt>id</tt>
−
| number
+
| number  
−
|-
+
| Unique ID of profile.
 
|}
 
|}
  
 
== DeleteUser ==
 
== DeleteUser ==
 +
Delete a MailStore user.
 +
 
=== Arguments ===
 
=== Arguments ===
 
{| class="wikitable"
 
{| class="wikitable"
 
! width=150px | Name
 
! width=150px | Name
 
! width=120px | Type
 
! width=120px | Type
 +
! Description
 
|-
 
|-
 
| <tt>instanceID</tt>
 
| <tt>instanceID</tt>
−
| string
+
| string  
 +
| Unique ID of MailStore instance in which this command is invoked.
 
|-
 
|-
 
| <tt>userName</tt>
 
| <tt>userName</tt>
−
| string
+
| string  
−
|-
+
| User name of MailStore user.
 
|}
 
|}
  
 
== GetChildFolders ==
 
== GetChildFolders ==
 +
Get child folders.
 +
 
=== Arguments ===
 
=== Arguments ===
 
{| class="wikitable"
 
{| class="wikitable"
 
! width=150px | Name
 
! width=150px | Name
 
! width=120px | Type
 
! width=120px | Type
 +
! Description
 
|-
 
|-
 
| <tt>instanceID</tt>
 
| <tt>instanceID</tt>
−
| string
+
| string  
 +
| Unique ID of MailStore instance in which this command is invoked.
 
|-
 
|-
 
| <tt>folder</tt>
 
| <tt>folder</tt>
−
| string ''(optional)''
+
| string (optional)
 +
| Parent folder.
 
|-
 
|-
 
| <tt>maxLevels</tt>
 
| <tt>maxLevels</tt>
−
| number ''(optional)''
+
| number (optional)
−
|-
+
| Depth of child folders.
 
|}
 
|}
  
 
== GetComplianceConfiguration ==
 
== GetComplianceConfiguration ==
 +
Get current compliance configuration settings.
 +
 
=== Arguments ===
 
=== Arguments ===
 
{| class="wikitable"
 
{| class="wikitable"
 
! width=150px | Name
 
! width=150px | Name
 
! width=120px | Type
 
! width=120px | Type
 +
! Description
 
|-
 
|-
 
| <tt>instanceID</tt>
 
| <tt>instanceID</tt>
 
| string  
 
| string  
−
|-
+
| Unique ID of MailStore instance in which this command is invoked.
 
|}
 
|}
  
 
== GetDirectoryServicesConfiguration ==
 
== GetDirectoryServicesConfiguration ==
 +
Get current Directory Services configuration settings.
 +
 
=== Arguments ===
 
=== Arguments ===
 
{| class="wikitable"
 
{| class="wikitable"
 
! width=150px | Name
 
! width=150px | Name
 
! width=120px | Type
 
! width=120px | Type
 +
! Description
 
|-
 
|-
 
| <tt>instanceID</tt>
 
| <tt>instanceID</tt>
−
| string
+
| 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.
 
|}
 
|}
  
−
== GetFolderStatistics ==
+
== GetMessages ==
 +
Get list of messages from a folder.
 +
 
 
=== Arguments ===
 
=== Arguments ===
 
{| class="wikitable"
 
{| class="wikitable"
 
! width=150px | Name
 
! width=150px | Name
 
! width=120px | Type
 
! width=120px | Type
 +
! Description
 
|-
 
|-
 
| <tt>instanceID</tt>
 
| <tt>instanceID</tt>
−
| string
+
| string  
 +
| Unique ID of MailStore instance in which this command is invoked.
 
|-
 
|-
 +
| <tt>folder</tt>
 +
| string (optional)
 +
| Folder whose content to list.
 
|}
 
|}
  
 
== GetProfiles ==
 
== GetProfiles ==
 +
Get list of archiving and exporting profiles.
 +
 
=== Arguments ===
 
=== Arguments ===
 
{| class="wikitable"
 
{| class="wikitable"
 
! width=150px | Name
 
! width=150px | Name
 
! width=120px | Type
 
! width=120px | Type
 +
! Description
 
|-
 
|-
 
| <tt>instanceID</tt>
 
| <tt>instanceID</tt>
−
| string
+
| string  
 +
| Unique ID of MailStore instance in which this command is invoked.
 
|-
 
|-
 
| <tt>raw</tt>
 
| <tt>raw</tt>
−
| bool
+
| bool  
−
|-
+
| Currently only 'true' is supported.
 
|}
 
|}
  
 
== GetTimeZones ==
 
== GetTimeZones ==
 +
Get list of available time zones.
 +
 
=== Arguments ===
 
=== Arguments ===
 
{| class="wikitable"
 
{| class="wikitable"
 
! width=150px | Name
 
! width=150px | Name
 
! width=120px | Type
 
! width=120px | Type
 +
! Description
 
|-
 
|-
 
| <tt>instanceID</tt>
 
| <tt>instanceID</tt>
−
| string
+
| string  
−
|-
+
| Unique ID of MailStore instance in which this command is invoked.
 
|}
 
|}
  
 
== GetUserInfo ==
 
== GetUserInfo ==
 +
Get detailed information about user.
 +
 
=== Arguments ===
 
=== Arguments ===
 
{| class="wikitable"
 
{| class="wikitable"
 
! width=150px | Name
 
! width=150px | Name
 
! width=120px | Type
 
! width=120px | Type
 +
! Description
 
|-
 
|-
 
| <tt>instanceID</tt>
 
| <tt>instanceID</tt>
−
| string
+
| string  
 +
| Unique ID of MailStore instance in which this command is invoked.
 
|-
 
|-
 
| <tt>userName</tt>
 
| <tt>userName</tt>
−
| string
+
| string  
−
|-
+
| User name of MailStore user
 
|}
 
|}
  
 
== GetUsers ==
 
== GetUsers ==
 +
Get list of users.
 +
 
=== Arguments ===
 
=== Arguments ===
 
{| class="wikitable"
 
{| class="wikitable"
 
! width=150px | Name
 
! width=150px | Name
 
! width=120px | Type
 
! width=120px | Type
 +
! Description
 
|-
 
|-
 
| <tt>instanceID</tt>
 
| <tt>instanceID</tt>
−
| string
+
| string  
−
|-
+
| Unique ID of MailStore instance in which this command is invoked.
 
|}
 
|}
  
 
== GetWorkerResults ==
 
== GetWorkerResults ==
 +
Get results of profile executions.
 +
 
=== Arguments ===
 
=== Arguments ===
 
{| class="wikitable"
 
{| class="wikitable"
 
! width=150px | Name
 
! width=150px | Name
 
! width=120px | Type
 
! width=120px | Type
 +
! Description
 
|-
 
|-
 
| <tt>instanceID</tt>
 
| <tt>instanceID</tt>
−
| string
+
| string  
 +
| Unique ID of MailStore instance in which this command is invoked.
 
|-
 
|-
 
| <tt>fromIncluding</tt>
 
| <tt>fromIncluding</tt>
−
| string
+
| string  
 +
| Beginning of time range to fetch.
 
|-
 
|-
 
| <tt>toExcluding</tt>
 
| <tt>toExcluding</tt>
−
| string
+
| string  
 +
| End of time range to fetch.
 
|-
 
|-
 
| <tt>timeZoneID</tt>
 
| <tt>timeZoneID</tt>
−
| string
+
| string  
 +
| Time zone in which timestamp should be returned.
 
|-
 
|-
 
| <tt>profileID</tt>
 
| <tt>profileID</tt>
−
| number ''(optional)''
+
| number (optional)
 +
| Filter results by given profile ID.
 
|-
 
|-
 
| <tt>userName</tt>
 
| <tt>userName</tt>
−
| string ''(optional)''
+
| string (optional)
−
|-
+
| Filter results by given user name.
 
|}
 
|}
  
−
==== fromIncluding and toExcluding format ====
+
== MoveFolder ==
−
{| class="wikitable"
+
Move folder.
−
! width=150px | Value
 
−
! width=120px | Format
 
−
|-
 
−
| <tt>fromIncluding</tt> and <tt>toExcluding</tt>
 
−
| YYYY-MM-DDT00:00:00 Example 2013-10-01T00:00:00
 
−
|-
 
−
|}
 
−
 
 
−
The timeZoneID can be gathered with the GetTimeZones command.
 
  
−
== MoveFolder ==
 
 
=== Arguments ===
 
=== Arguments ===
 
{| class="wikitable"
 
{| class="wikitable"
 
! width=150px | Name
 
! width=150px | Name
 
! width=120px | Type
 
! width=120px | Type
 +
! Description
 
|-
 
|-
 
| <tt>instanceID</tt>
 
| <tt>instanceID</tt>
−
| string
+
| string  
 +
| Unique ID of MailStore instance in which this command is invoked.
 
|-
 
|-
 
| <tt>fromFolder</tt>
 
| <tt>fromFolder</tt>
−
| string
+
| string  
 +
| Old folder name.
 
|-
 
|-
 
| <tt>toFolder</tt>
 
| <tt>toFolder</tt>
−
| string
+
| string  
−
|-
+
| New folder name.
 
|}
 
|}
  
 
== RenameUser ==
 
== RenameUser ==
 +
Rename a MailStore user.
 +
 
=== Arguments ===
 
=== Arguments ===
 
{| class="wikitable"
 
{| class="wikitable"
 
! width=150px | Name
 
! width=150px | Name
 
! width=120px | Type
 
! width=120px | Type
 +
! Description
 
|-
 
|-
 
| <tt>instanceID</tt>
 
| <tt>instanceID</tt>
−
| string
+
| string  
 +
| Unique ID of MailStore instance in which this command is invoked.
 
|-
 
|-
 
| <tt>oldUserName</tt>
 
| <tt>oldUserName</tt>
−
| string
+
| string  
 +
| Old user name.
 
|-
 
|-
 
| <tt>newUserName</tt>
 
| <tt>newUserName</tt>
−
| string
+
| string  
−
|-
+
| New user name.
 
|}
 
|}
  
 
== RunProfile ==
 
== RunProfile ==
 +
Run an existing archiving or exporting profile.
 +
 
=== Arguments ===
 
=== Arguments ===
 
{| class="wikitable"
 
{| class="wikitable"
 
! width=150px | Name
 
! width=150px | Name
 
! width=120px | Type
 
! width=120px | Type
 +
! Description
 
|-
 
|-
 
| <tt>instanceID</tt>
 
| <tt>instanceID</tt>
−
| string
+
| string  
 +
| Unique ID of MailStore instance in which this command is invoked.
 
|-
 
|-
 
| <tt>id</tt>
 
| <tt>id</tt>
−
| number
+
| number  
−
|-
+
| Unique profile ID.
 
|}
 
|}
  
 
== RunTemporaryProfile ==
 
== RunTemporaryProfile ==
 +
Run a temporary/non-existent profile.
 +
 
=== Arguments ===
 
=== Arguments ===
 
{| class="wikitable"
 
{| class="wikitable"
 
! width=150px | Name
 
! width=150px | Name
 
! width=120px | Type
 
! width=120px | Type
 +
! Description
 
|-
 
|-
 
| <tt>instanceID</tt>
 
| <tt>instanceID</tt>
−
| string
+
| string  
 +
| Unique ID of MailStore instance in which this command is invoked.
 
|-
 
|-
 
| <tt>properties</tt>
 
| <tt>properties</tt>
−
| json
+
| json  
 +
| Profile properties.
 
|-
 
|-
 
| <tt>raw</tt>
 
| <tt>raw</tt>
−
| bool
+
| bool  
 +
| Currently only 'true' is supported.
 +
|}
 +
 
 +
=== Argument Values ===
 +
 
 +
== 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 ====
 +
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
 +
UseGetComplianceConfigurationtoreceivesupportedvalue.
 +
</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.
 
|}
 
|}
  
−
=== Properties Object Definition ===
+
=== Argument Values ===
  
−
To receive available profile properties create a profile of the desired type manually and use the [[#GetProfiles|GetProfiles]] function.
+
==== config ====
 +
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
 +
UseGetDirectoryServicesConfigurationtoreceivesupportedvalue.
 +
</source>
  
 
== SetUserAuthentication ==
 
== SetUserAuthentication ==
 +
Set authentication settings of a MailStore user.
 +
 
=== Arguments ===
 
=== Arguments ===
 
{| class="wikitable"
 
{| class="wikitable"
 
! width=150px | Name
 
! width=150px | Name
 
! width=120px | Type
 
! width=120px | Type
 +
! Description
 
|-
 
|-
 
| <tt>instanceID</tt>
 
| <tt>instanceID</tt>
−
| string
+
| string  
 +
| Unique ID of MailStore instance in which this command is invoked.
 
|-
 
|-
 
| <tt>userName</tt>
 
| <tt>userName</tt>
−
| string
+
| string  
 +
| User name of MailStore user.
 
|-
 
|-
 
| <tt>authentication</tt>
 
| <tt>authentication</tt>
−
| string
+
| string  
−
|-
+
| Authentication method. Either 'Standard' or 'Windows Authentication'.
 
|}
 
|}
  
 
== SetUserDistinguishedName ==
 
== SetUserDistinguishedName ==
 +
Set the LDAP distinguished name of a MailStore user.
 +
 
=== Arguments ===
 
=== Arguments ===
 
{| class="wikitable"
 
{| class="wikitable"
 
! width=150px | Name
 
! width=150px | Name
 
! width=120px | Type
 
! width=120px | Type
 +
! Description
 
|-
 
|-
 
| <tt>instanceID</tt>
 
| <tt>instanceID</tt>
−
| string
+
| string  
 +
| Unique ID of MailStore instance in which this command is invoked.
 
|-
 
|-
 
| <tt>userName</tt>
 
| <tt>userName</tt>
−
| string
+
| string  
 +
| User name of MailStore user.
 
|-
 
|-
 
| <tt>distinguishedName</tt>
 
| <tt>distinguishedName</tt>
−
| string ''(optional)''
+
| string (optional)
−
|-
+
| LDAP DN string.
 
|}
 
|}
  
 
== SetUserEmailAddresses ==
 
== SetUserEmailAddresses ==
 +
Set email addresses of MailStore user.
 +
 
=== Arguments ===
 
=== Arguments ===
 
{| class="wikitable"
 
{| class="wikitable"
 
! width=150px | Name
 
! width=150px | Name
 
! width=120px | Type
 
! width=120px | Type
 +
! Description
 
|-
 
|-
 
| <tt>instanceID</tt>
 
| <tt>instanceID</tt>
−
| string
+
| string  
 +
| Unique ID of MailStore instance in which this command is invoked.
 
|-
 
|-
 
| <tt>userName</tt>
 
| <tt>userName</tt>
−
| string
+
| string  
 +
| User name of MailStore user.
 
|-
 
|-
 
| <tt>emailAddresses</tt>
 
| <tt>emailAddresses</tt>
−
| string ''(optional)''
+
| string (optional)
−
|-
+
| List of email addresses.
 
|}
 
|}
  
 
== SetUserFullName ==
 
== SetUserFullName ==
 +
Set full name of MailStore user.
 +
 
=== Arguments ===
 
=== Arguments ===
 
{| class="wikitable"
 
{| class="wikitable"
 
! width=150px | Name
 
! width=150px | Name
 
! width=120px | Type
 
! width=120px | Type
 +
! Description
 
|-
 
|-
 
| <tt>instanceID</tt>
 
| <tt>instanceID</tt>
−
| string
+
| string  
 +
| Unique ID of MailStore instance in which this command is invoked.
 
|-
 
|-
 
| <tt>userName</tt>
 
| <tt>userName</tt>
−
| string
+
| string  
 +
| User name of MailStore user.
 
|-
 
|-
 
| <tt>fullName</tt>
 
| <tt>fullName</tt>
−
| string ''(optional)''
+
| string (optional)
−
|-
+
| Full name of MailStore user.
 
|}
 
|}
  
 
== SetUserPassword ==
 
== SetUserPassword ==
 +
Set password of MailStore user.
 +
 
=== Arguments ===
 
=== Arguments ===
 
{| class="wikitable"
 
{| class="wikitable"
 
! width=150px | Name
 
! width=150px | Name
 
! width=120px | Type
 
! width=120px | Type
 +
! Description
 
|-
 
|-
 
| <tt>instanceID</tt>
 
| <tt>instanceID</tt>
−
| string
+
| string  
 +
| Unique ID of MailStore instance in which this command is invoked.
 
|-
 
|-
 
| <tt>userName</tt>
 
| <tt>userName</tt>
−
| string
+
| string  
 +
| User name of MailStore user.
 
|-
 
|-
 
| <tt>password</tt>
 
| <tt>password</tt>
−
| string
+
| string  
−
|-
+
| Password of MailStore user.
 
|}
 
|}
  
 
== SetUserPop3UserNames ==
 
== SetUserPop3UserNames ==
 +
Set POP3 user name of MailStore user.
 +
 
=== Arguments ===
 
=== Arguments ===
 
{| class="wikitable"
 
{| class="wikitable"
 
! width=150px | Name
 
! width=150px | Name
 
! width=120px | Type
 
! width=120px | Type
 +
! Description
 
|-
 
|-
 
| <tt>instanceID</tt>
 
| <tt>instanceID</tt>
−
| string
+
| string  
 +
| Unique ID of MailStore instance in which this command is invoked.
 
|-
 
|-
 
| <tt>userName</tt>
 
| <tt>userName</tt>
−
| string
+
| string  
 +
| User name of MailStore user.
 
|-
 
|-
 
| <tt>pop3UserNames</tt>
 
| <tt>pop3UserNames</tt>
−
| string ''(optional)''
+
| string (optional)
−
|-
+
| Comma seperated list of POP3 user names.
 
|}
 
|}
  
 
== SetUserPrivileges ==
 
== SetUserPrivileges ==
 +
Set privileges of MailStore user.
 +
 
=== Arguments ===
 
=== Arguments ===
 
{| class="wikitable"
 
{| class="wikitable"
 
! width=150px | Name
 
! width=150px | Name
 
! width=120px | Type
 
! width=120px | Type
 +
! Description
 
|-
 
|-
 
| <tt>instanceID</tt>
 
| <tt>instanceID</tt>
−
| string
+
| string  
 +
| Unique ID of MailStore instance in which this command is invoked.
 
|-
 
|-
 
| <tt>userName</tt>
 
| <tt>userName</tt>
−
| string
+
| string  
 +
| User name of MailStore user.
 
|-
 
|-
 
| <tt>privileges</tt>
 
| <tt>privileges</tt>
−
| string
+
| string  
−
|-
+
| Comma separated list of privileges.
 
|}
 
|}
  
 
== SetUserPrivilegesOnFolder ==
 
== SetUserPrivilegesOnFolder ==
 +
Set privileges on folder for MailStore user.
 +
 
=== Arguments ===
 
=== Arguments ===
 
{| class="wikitable"
 
{| class="wikitable"
 
! width=150px | Name
 
! width=150px | Name
 
! width=120px | Type
 
! width=120px | Type
 +
! Description
 
|-
 
|-
 
| <tt>instanceID</tt>
 
| <tt>instanceID</tt>
−
| string
+
| string  
 +
| Unique ID of MailStore instance in which this command is invoked.
 
|-
 
|-
 
| <tt>userName</tt>
 
| <tt>userName</tt>
−
| string
+
| string  
 +
| User name of MailStore user.
 
|-
 
|-
 
| <tt>folder</tt>
 
| <tt>folder</tt>
−
| string
+
| string  
 +
| Folder name.
 
|-
 
|-
 
| <tt>privileges</tt>
 
| <tt>privileges</tt>
−
| string
+
| string  
−
|-
+
| Comma separated list of folder privileges.
 
|}
 
|}
  
 
== SyncUsersWithDirectoryServices ==
 
== SyncUsersWithDirectoryServices ==
 +
Sync users of MailStore instance with directory services.
 +
 
=== Arguments ===
 
=== Arguments ===
 
{| class="wikitable"
 
{| class="wikitable"
 
! width=150px | Name
 
! width=150px | Name
 
! width=120px | Type
 
! width=120px | Type
 +
! Description
 
|-
 
|-
 
| <tt>instanceID</tt>
 
| <tt>instanceID</tt>
−
| string
+
| string  
 +
| Unique ID of MailStore instance in which this command is invoked.
 
|-
 
|-
 
| <tt>dryRun</tt>
 
| <tt>dryRun</tt>
−
| bool ''(optional)''
+
| bool (optional)
−
|-
+
| Simulate sync only.
 
|}
 
|}

Revision as of 10:12, 2 September 2014


AttachStore

Attach existing archive store.

Arguments

Name Type Description
instanceID string Unique ID of MailStore instance in which this command is invoked.
name string Meaningful name of archive store.
path string Path of directory containing archive store data.
requestedState string (optional) State of archive store after attaching.

Argument Values

requestedState

Name Description
current Same as Normal but new messages will be archived in the archive store that is set to Current.
normal The content of archives store is available to users and can be modified if the user has the appropriate permission.
writeProtected 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)
disabled 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

Name Type Description
instanceID string Unique ID of MailStore instance in which this command is invoked.
id number Unique ID of archive store

CreateClientAccessServer

Register new client access server.

Arguments

Name Type Description
config json Configuration of new Client Access Server.

Argument Values

config

{
  "serverName" : string,
  "port" : number,
  "serverCertificate" : {
    "thumbprint" : string
  }
}

CreateClientOneTimeUrlForArchiveAdmin

Create URL including OTP for $archiveadmin access.

Arguments

Name Type Description
instanceID string Unique ID of MailStore instance in which this command is invoked.
instanceUrl string (optional) Base URL for accessing instance.

CreateDirectoryOnInstanceHost

Create a directory on an Instance Host

Arguments

Name Type Description
serverName string Name of Instance Host.
path string Path of directory to create.

CreateInstance

Create new MailStore instance.

Arguments

Name Type Description
config json Configuration of new instance.

Argument Values

config

{
  "instanceID" : string,
  "alias" : string,
  "displayName" : string,
  "instanceHost" : string,
  "startMode" : string,
  "baseDirectory" : string,
  "debugLogEnabled" : bool,
  "vssWriterEnabled" : bool
}

CreateInstanceHost

Create a new Instance Host.

Arguments

Name Type Description
config json Configuration of new Instance Host.

Argument Values

config

{
  "serverName" : string,
  "port" : number,
  "serverCertificate" : {
    "thumbprint" : string
  }
}

CreateLicenseRequest

Create and return data of a license request.

Arguments

Name Type Description

CreateStore

Create and attach a new archive store.

Arguments

Name Type Description
instanceID string Unique ID of MailStore instance in which this command is invoked.
name string Meaningful name of archive store.
path string Path of directory containing archive store data.
requestedState string (optional) State of archive store after attaching.

Argument Values

requestedState

Name Description
current Same as Normal but new messages will be archived in the archive store that is set to Current.
normal The content of archives store is available to users and can be modified if the user has the appropriate permission.
writeProtected 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)
disabled 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

Name Type Description
config json Configuration of new SPE system administrator.
password string Password of new SPE system administrator.

Argument Values

DeleteClientAccessServer

Delete Client Access Server from management database.

Arguments

Name Type Description
serverName string Name of Client Access Server.

DeleteInstanceHost

Delete Instance Host from management database.

Arguments

Name Type Description
serverName string Name of Instance Host.

DeleteInstances

Delete one or multiple MailStore Instances

Arguments

Name Type Description
instanceFilter string Instance filter string.

Argument Values

instanceFilter

Name Description
* All instances
instance01 instance02 instance03 instance01, instance02 and instance03
*instancehost01 *instancehost02 All instances on instancehost1 and instancehost2
* .running All running instances
* .stopped All stopped instances

DeleteSystemAdministrator

Delete SPE system administrator.

Arguments

Name Type Description
userName string User name of SPE system administrator.

DetachStore

Detach archive store

Arguments

Name Type Description
instanceID string Unique ID of MailStore instance in which this command is invoked.
id number Unique ID of archive store.

FreezeInstances

Freeze a MailStore Instance

Arguments

Name Type Description
instanceFilter string Instance filter string.

Argument Values

instanceFilter

Name Description
* All instances
instance01 instance02 instance03 instance01, instance02 and instance03
*instancehost01 *instancehost02 All instances on instancehost1 and instancehost2
* .running All running instances
* .stopped All stopped instances

GetArchiveAdminEnabled

Get currrent state of archive admin access.

Arguments

Name Type Description
instanceID string Unique ID of MailStore instance in which this command is invoked.

GetClientAccessServers

Get list of Client Access Servers.

Arguments

Name Type Description
serverNameFilter string (optional) Server name filter string.
withServiceStatus bool Include service status or not.

Argument Values

GetDirectoriesOnInstanceHost

Get file system directory structure from Instance Host.

Arguments

Name Type Description
serverName string Name of Instance Host.
path string (optional) Path of directory to obtain subdirectories from.

GetEnvironmentInfo

Return general information about SPE environment.

Arguments

Name Type Description

GetIndexConfiguration

Get list of attachment file types to index.

Arguments

Name Type Description
instanceID string Unique ID of MailStore instance in which this command is invoked.

GetInstanceConfiguration

Get configuration of MailStore Instance.

Arguments

Name Type Description
instanceID string Unique ID of MailStore instance in which this command is invoked.

GetInstanceHosts

Get list of Instance Hosts.

Arguments

Name Type Description
serverNameFilter string (optional) Server name filter string.

Argument Values

serverNameFilter

Name Description
null All servers
serverName Only the given serverName. Must match exactly.

GetInstanceProcessLiveStatistics

Get live statistics from instance process.

Arguments

Name Type Description
instanceID string Unique ID of MailStore instance in which this command is invoked.

GetInstances

Get list of instances.

Arguments

Name Type Description
instanceFilter string Instance filter string.

Argument Values

instanceFilter

Name Description
* All instances
instance01 instance02 instance03 instance01, instance02 and instance03
*instancehost01 *instancehost02 All instances on instancehost1 and instancehost2
* .running All running instances
* .stopped All stopped instances

GetInstanceStatistics

Get archive statistics from instance.

Arguments

Name Type Description
instanceID string Unique ID of MailStore instance in which this command is invoked.

GetServiceStatus

Get current status of all SPE services.

Arguments

Name Type Description

GetStoreAutoCreateConfiguration

Get automatic archive store creation settings.

Arguments

Name Type Description
instanceID string Unique ID of MailStore instance in which this command is invoked.

GetStores

Get list of archive stores.

Arguments

Name Type Description
instanceID string Unique ID of MailStore instance in which this command is invoked.

GetSystemAdministrators

Get list of system administrators.

Arguments

Name Type Description

MaintainFileSystemDatabases

Execute maintenance task on archive store databases.

Arguments

Name Type Description
instanceID string Unique ID of MailStore instance in which this command is invoked.

MergeStore

Merge two archive stores.

Arguments

Name Type Description
instanceID string Unique ID of MailStore instance in which this command is invoked.
id number Unique ID of destination archive store.
sourceId number Unique ID of source archive store.

PairWithManagementServer

Pair server role with Management Server.

Arguments

Name Type Description
serverType string Type of server role.
serverName string Name of server that hosts 'serverType' role.
port number TCP port on which 'serverType' role on 'serverName' accepts connections.
thumbprint string Thumbprint of SSL certificate used by serverType' role on 'serverName'

Argument Values

Ping

Send a keep alive packet.

Arguments

Name Type Description

RebuildSelectedStoreIndexes

Rebuild search indexes of selected archive stores.

Arguments

Name Type Description
instanceID string Unique ID of MailStore instance in which this command is invoked.

RefreshAllStoreStatistics

Refresh archive store statistics.

Arguments

Name Type Description
instanceID string Unique ID of MailStore instance in which this command is invoked.

RenameStore

Rename archvive store

Arguments

Name Type Description
instanceID string Unique ID of MailStore instance in which this command is invoked.
id number Unique ID of archive store.
name string New name of archive store.

RestartInstances

Restart one or multiple instances.

Arguments

Name Type Description
instanceFilter string Instance filter string.

Argument Values

instanceFilter

Name Description
* All instances
instance01 instance02 instance03 instance01, instance02 and instance03
*instancehost01 *instancehost02 All instances on instancehost1 and instancehost2
* .running All running instances
* .stopped All stopped instances

RetryOpenStores

Retry opening stores that failed previously

Arguments

Name Type Description
instanceID string Unique ID of MailStore instance in which this command is invoked.

SelectAllStoreIndexesForRebuild

Select all archive store for rebuild.

Arguments

Name Type Description
instanceID string Unique ID of MailStore instance in which this command is invoked.

SetArchiveAdminEnabled

Enable or disable archive admin access.

Arguments

Name Type Description
instanceID string Unique ID of MailStore instance in which this command is invoked.
enabled bool Enable or disable flag.

SetClientAccessServerConfiguration

Set the configuration of a Client Access Server.

Arguments

Name Type Description
config json Client Access Server configuration.

Argument Values

config

{
  "serverName" : string,
  "port" : number,
  "serverCertificate" : {
    "thumbprint" : string
  }
}

SetIndexConfiguration

Set full text search index configuration.

Arguments

Name Type Description
instanceID string Unique ID of MailStore instance in which this command is invoked.
config json Full text search index configuration.

Argument Values

config

UseGetIndexConfigurationtoreveivesupportedvalue.

SetInstanceConfiguration

Set configuration of MailStore Instance.

Arguments

Name Type Description
config json Instance configuration.

Argument Values

config

{
  "instanceID" : string,
  "alias" : string,
  "displayName" : string,
  "instanceHost" : string,
  "startMode" : string,
  "baseDirectory" : string,
  "debugLogEnabled" : bool,
  "vssWriterEnabled" : bool
}

SetInstanceHostConfiguration

Set configuration of Instance Host.

Arguments

Name Type Description
config json Instance Host configuration.

Argument Values

config

{
  "serverName" : string,
  "port" : number,
  "serverCertificate" : {
    "thumbprint" : string
  },
  "baseDirectory" : string
}

SetStoreAutoCreateConfiguration

Set configuration for automatic archive store creation.

Arguments

Name Type Description
instanceID string Unique ID of MailStore instance in which this command is invoked.
config json Archive store automatic creation configuration.

Argument Values

config

{
  "enabled" : bool,
  "interval" : string,
  "sizeThreshold" : string,
  "numberOfMessagesThreshold" : number,
  "baseDirectory" : string
}

SetStorePath

Set the path to archive store data.

Arguments

Name Type Description
instanceID string Unique ID of MailStore instance in which this command is invoked.
id number Unique ID of archive store.
path string Path to archvie store data.

SetStoreRequestedState

Set state of archive store.

Arguments

Name Type Description
instanceID string Unique ID of MailStore instance in which this command is invoked.
id number Unique ID of archive store.
requestedState string State of archive store.

Argument Values

requestedState

Name Description
current Same as Normal but new messages will be archived in the archive store that is set to Current.
normal The content of archives store is available to users and can be modified if the user has the appropriate permission.
writeProtected 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)
disabled Disabled archive stores are not in use but the instance still knows about their existence. Therefore the content is not available to users.

SetSystemAdministratorConfiguration

Set SPE system adminstrator configuration.

Arguments

Name Type Description
config json SPE system adminstrator configuration.

Argument Values

config

{
  "fullName" : string
}

SetSystemAdministratorPassword

Set password for SPE system administrator.

Arguments

Name Type Description
userName string User name of SPE system administrator.
password string New password for SPE system administrator.

StartInstances

Start one or multiple MailStore Instances.

Arguments

Name Type Description
instanceFilter string Instance filter string.

Argument Values

instanceFilter

Name Description
* All instances
instance01 instance02 instance03 instance01, instance02 and instance03
*instancehost01 *instancehost02 All instances on instancehost1 and instancehost2
* .running All running instances
* .stopped All stopped instances

StopInstances

Stop one or multiple MailStore Instances.

Arguments

Name Type Description
instanceFilter string Instance filter string.

Argument Values

instanceFilter

Name Description
* All instances
instance01 instance02 instance03 instance01, instance02 and instance03
*instancehost01 *instancehost02 All instances on instancehost1 and instancehost2
* .running All running instances
* .stopped All stopped instances

ThawInstances

Thaw one or multiple MailStore Instances.

Arguments

Name Type Description
instanceFilter string Instance filter string.

Argument Values

instanceFilter

Name Description
* All instances
instance01 instance02 instance03 instance01, instance02 and instance03
*instancehost01 *instancehost02 All instances on instancehost1 and instancehost2
* .running All running instances
* .stopped All stopped instances

UpgradeStore

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

Arguments

Name Type Description
instanceID string Unique ID of MailStore instance in which this command is invoked.
id number Unique ID of archive store.

VerifyStore

Verify archive stores consistency.

Arguments

Name Type Description
instanceID string Unique ID of MailStore instance in which this command is invoked.
id number Unique ID of archive store.

ClearUserPrivilegesOnFolders

Removes all privileges of a user on all archive folders.

Arguments

Name Type Description
instanceID string Unique ID of MailStore instance in which this command is invoked.
userName string User name of MailStore user.

CreateProfile

Create a new archiving or exporting profile.

Arguments

Name Type Description
instanceID string Unique ID of MailStore instance in which this command is invoked.
properties json Profile properties.
raw bool Currently only 'true' is supported.

Argument Values

CreateUser

Create new MailStore user.

Arguments

Name Type Description
instanceID string Unique ID of MailStore instance in which this command is invoked.
userName string User name of new MailStore user.
privileges string Comma separated list of privileges.
fullName string (optional) Full name of user.
distinguishedName string (optional) LDAP DN string.
authentication string (optional) Authentication setting for user: 'Standard' or 'DirectoryService'.
password string (optional) Password of new user.

DeleteEmptyFolders

Remove folders from folder tree that do not contain emails.

Arguments

Name Type Description
instanceID string Unique ID of MailStore instance in which this command is invoked.
folder string (optional) Entry point in folder tree.

DeleteMessage

Delete a single message

Arguments

Name Type Description
instanceID string Unique ID of MailStore instance in which this command is invoked.
id string (optional) Unique ID of message. Format: <store_id>:<message_num>

DeleteProfile

Delete an archiving or exporting profile.

Arguments

Name Type Description
instanceID string Unique ID of MailStore instance in which this command is invoked.
id number Unique ID of profile.

DeleteUser

Delete a MailStore user.

Arguments

Name Type Description
instanceID string Unique ID of MailStore instance in which this command is invoked.
userName string User name of MailStore user.

GetChildFolders

Get child folders.

Arguments

Name Type Description
instanceID string Unique ID of MailStore instance in which this command is invoked.
folder string (optional) Parent folder.
maxLevels number (optional) Depth of child folders.

GetComplianceConfiguration

Get current compliance configuration settings.

Arguments

Name Type Description
instanceID string Unique ID of MailStore instance in which this command is invoked.

GetDirectoryServicesConfiguration

Get current Directory Services configuration settings.

Arguments

Name Type Description
instanceID string Unique ID of MailStore instance in which this command is invoked.

GetFolderStatistics

Get folder statistics.

Arguments

Name Type Description
instanceID string Unique ID of MailStore instance in which this command is invoked.

GetMessages

Get list of messages from a folder.

Arguments

Name Type Description
instanceID string Unique ID of MailStore instance in which this command is invoked.
folder string (optional) Folder whose content to list.

GetProfiles

Get list of archiving and exporting profiles.

Arguments

Name Type Description
instanceID string Unique ID of MailStore instance in which this command is invoked.
raw bool Currently only 'true' is supported.

GetTimeZones

Get list of available time zones.

Arguments

Name Type Description
instanceID string Unique ID of MailStore instance in which this command is invoked.

GetUserInfo

Get detailed information about user.

Arguments

Name Type Description
instanceID string Unique ID of MailStore instance in which this command is invoked.
userName string User name of MailStore user

GetUsers

Get list of users.

Arguments

Name Type Description
instanceID string Unique ID of MailStore instance in which this command is invoked.

GetWorkerResults

Get results of profile executions.

Arguments

Name Type Description
instanceID string Unique ID of MailStore instance in which this command is invoked.
fromIncluding string Beginning of time range to fetch.
toExcluding string End of time range to fetch.
timeZoneID string Time zone in which timestamp should be returned.
profileID number (optional) Filter results by given profile ID.
userName string (optional) Filter results by given user name.

MoveFolder

Move folder.

Arguments

Name Type Description
instanceID string Unique ID of MailStore instance in which this command is invoked.
fromFolder string Old folder name.
toFolder string New folder name.

RenameUser

Rename a MailStore user.

Arguments

Name Type Description
instanceID string Unique ID of MailStore instance in which this command is invoked.
oldUserName string Old user name.
newUserName string New user name.

RunProfile

Run an existing archiving or exporting profile.

Arguments

Name Type Description
instanceID string Unique ID of MailStore instance in which this command is invoked.
id number Unique profile ID.

RunTemporaryProfile

Run a temporary/non-existent profile.

Arguments

Name Type Description
instanceID string Unique ID of MailStore instance in which this command is invoked.
properties json Profile properties.
raw bool Currently only 'true' is supported.

Argument Values

SetComplianceConfiguration

Set compliance configuration settings.

Arguments

Name Type Description
instanceID string Unique ID of MailStore instance in which this command is invoked.
config json Compliance configuration.

Argument Values

config

UseGetComplianceConfigurationtoreceivesupportedvalue.

SetDirectoryServicesConfiguration

Set directory services configuration settings.

Arguments

Name Type Description
instanceID string Unique ID of MailStore instance in which this command is invoked.
config json Directory services configuration.

Argument Values

config

UseGetDirectoryServicesConfigurationtoreceivesupportedvalue.

SetUserAuthentication

Set authentication settings of a MailStore user.

Arguments

Name Type Description
instanceID string Unique ID of MailStore instance in which this command is invoked.
userName string User name of MailStore user.
authentication string Authentication method. Either 'Standard' or 'Windows Authentication'.

SetUserDistinguishedName

Set the LDAP distinguished name of a MailStore user.

Arguments

Name Type Description
instanceID string Unique ID of MailStore instance in which this command is invoked.
userName string User name of MailStore user.
distinguishedName string (optional) LDAP DN string.

SetUserEmailAddresses

Set email addresses of MailStore user.

Arguments

Name Type Description
instanceID string Unique ID of MailStore instance in which this command is invoked.
userName string User name of MailStore user.
emailAddresses string (optional) List of email addresses.

SetUserFullName

Set full name of MailStore user.

Arguments

Name Type Description
instanceID string Unique ID of MailStore instance in which this command is invoked.
userName string User name of MailStore user.
fullName string (optional) Full name of MailStore user.

SetUserPassword

Set password of MailStore user.

Arguments

Name Type Description
instanceID string Unique ID of MailStore instance in which this command is invoked.
userName string User name of MailStore user.
password string Password of MailStore user.

SetUserPop3UserNames

Set POP3 user name of MailStore user.

Arguments

Name Type Description
instanceID string Unique ID of MailStore instance in which this command is invoked.
userName string User name of MailStore user.
pop3UserNames string (optional) Comma seperated list of POP3 user names.

SetUserPrivileges

Set privileges of MailStore user.

Arguments

Name Type Description
instanceID string Unique ID of MailStore instance in which this command is invoked.
userName string User name of MailStore user.
privileges string Comma separated list of privileges.

SetUserPrivilegesOnFolder

Set privileges on folder for MailStore user.

Arguments

Name Type Description
instanceID string Unique ID of MailStore instance in which this command is invoked.
userName string User name of MailStore user.
folder string Folder name.
privileges string Comma separated list of folder privileges.

SyncUsersWithDirectoryServices

Sync users of MailStore instance with directory services.

Arguments

Name Type Description
instanceID string Unique ID of MailStore instance in which this command is invoked.
dryRun bool (optional) Simulate sync only.
Retrieved from "https://help.mailstore.com/en/spe/index.php?title=Management_API_-_Function_Reference&oldid=1105"