Management API - Function Reference

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.

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.

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.

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.

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.

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.

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'

Ping

Send a keep alive packet.

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

Use GetIndexConfiguration to reveive supported value.

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.

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: 'integrated' or 'directoryServices'.
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.

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

Use GetComplianceConfiguration to receive supported value.

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

Use GetDirectoryServicesConfiguration to receive supported value.

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 'integrated' or 'directoryServices'.

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.