Difference between revisions of "Management API - Function Reference"

[unchecked revision]

[checked revision]

Revision as of 17:14, 10 December 2019

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.

Argument Values

config

{
  "userName" : string,
  "fullName" : string,
  "emailAddress" : string
}

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

serverNameFilter

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

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.

GetSystemSmtpConfiguration

Get current system wide SMTP configuration.

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'

Argument Values

serverType

Name	Description
`instanceHost`	Pairing an Instance Host.
`clientAccessServer`	Pairing a Client Access Server.

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.

RecoverStore

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

Arguments

Name	Type	Description
`instanceID`	string	Unique ID of MailStore instance in which this command is invoked.
`id`	number	Unique ID of archive store.
`encryptionKey`	string (optional)	Encryption key of the archive store.

RecreateRecoveryRecords

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

Arguments

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

RefreshAllStoreStatistics

Refresh archive store statistics.

Arguments

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

ReloadBranding

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

RenameStore

Rename archive store

Arguments

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

RepairStoreDatabase

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

Arguments

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

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 receive 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 archive 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 administrator configuration.

Arguments

Name	Type	Description
`config`	json	SPE system administrator configuration.

Argument Values

config

{
  "userName" : string,
  "fullName" : string,
  "emailAddress" : 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.

SetSystemSmtpConfiguration

Set system wide SMTP configuration.

Arguments

Name	Type	Description
`config`	json	SMTP configuration.

Argument Values

config

Example config object:

{
  "hostname": "mail.example.com",
  "port": 587,
  "protocol": "SMTP-TLS",
  "ignoreSslPolicyErrors": false,
  "authenticationRequired": true,
  "username": "[email protected]",
  "password": "userpassword",
  "fromDisplayName": "Sending User",
  "fromEmailAddress": "[email protected]",
  "recipientSystemAdministrator": ["admin", "johndoe"]
}

StartInstances

Start one or multiple MailStore Instances.

Arguments

Name	Type	Description
`instanceFilter`	string	Instance filter string.
`safeMode`	bool (optional)	Start instances in Safe Mode to perform maintenance.

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

TestSystemSmtpConfiguration

Test current system wide SMTP configuration.

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.
`includeIndexes`	bool	Defines whether to verify the search indexes as well.

VerifyStores

Verify consistency of all archive stores.

Arguments

Name	Type	Description
`instanceID`	string	Unique ID of MailStore instance in which this command is invoked.
`includeIndexes`	bool	Defines whether to verify the search indexes as well.

CancelJobAsync

Cancel a running job asynchronously.

Arguments

Name	Type	Description
`instanceID`	string	Unique ID of MailStore instance in which this command is invoked.
`id`	number	The unique identifier of the job to be canceled.

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.

CreateJob

Create a new job to execute Management API commands.

Arguments

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

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

Argument Values

interval

Name	Description
`5`	Every 5 minutes.
`10`	Every 10 minutes.
`15`	Every 15 minutes.
`20`	Every 20 minutes.
`30`	Every 30 minutes.
`60`	Every hour.
`120`	Every 2 hours.
`180`	Every 3 hours.
`240`	Every 4 hours.
`360`	Every 6 hours.
`720`	Every 12 hours.

dayOfWeek

Name	Description
`Sunday`	Sunday
`Monday`	Monday
`Tuesday`	Tuesday
`Wednesday`	Wednesday
`Thursday`	Thursday
`Friday`	Friday
`Saturday`	Saturday

dayOfMonth

Name	Description
`1 to 31`	Numeric representation of day of month.
`Last`	Last day of month.

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

properties

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

CreateUser

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

Arguments

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.

Argument Values

privileges

Name	Description
`none`	The user is granted no global privileges. If specified, this value has to be the only value in the list.
`admin`	The user is granted administrator privileges. If specified, this value has to be the only value in the list.
`login`	The user can log on to MailStore Server.
`changePassword`	The user can change his own MailStore Server password. This only makes sense if the authentication is set to integrated.
`archive`	The user can run archiving profiles.
`modifyArchiveProfiles`	The user can create, modify and delete archiving profiles.
`export`	The user can run export profiles.
`modifyExportProfiles`	The user can create, modify and delete export profiles.
`delete`	The user can delete messages. Please note that a non-admin user can only delete messages in folders where he has been granted delete access. In addition, compliance settings may be in effect, keeping administrators and users from deleting messages even if they have been granted the privilege to do so.

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.

DeleteJob

Deletes a job.

Arguments

Name	Type	Description
`instanceID`	string	Unique ID of MailStore instance in which this command is invoked.
`id`	string (optional)	The unique identifier of the job to be deleted.

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.

GetJobResults

Retrieves list of finished job 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	The time zone id of the time zone the date should be converted to, e.g. $Local, which represents the time zone of the operating system.
`jobId`	number (optional)	The job id for which to retrieve results.

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

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

GetJobs

Retrieve list of jobs

Arguments

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

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.

GetSmtpSettings

Get current SMTP configuration.

Arguments

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

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	The time zone id of the time zone the date should be converted to, e.g. $Local, which represents the time zone of the operating system.
`profileID`	number (optional)	Filter results by given profile ID.
`userName`	string (optional)	Filter results by given user name.

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

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

MoveFolder

Move folder.

Arguments

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.

RenameJob

Rename job.

Arguments

Name	Type	Description
`instanceID`	string	Unique ID of MailStore instance in which this command is invoked.
`id`	number (optional)	The unique identifier of the job to be renamed.
`name`	string (optional)	The new job 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.

RunJobAsync

Run an existing job.

Arguments

Name	Type	Description
`instanceID`	string	Unique ID of MailStore instance in which this command is invoked.
`id`	number	The identifier of the job to be run.

RunProfile

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

Arguments

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. Only profiles that are executed on server side can be started by this command. That are all profiles which are listed under E-Mail Servers in the E-Mail-Archive Client.

Arguments

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

properties

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

SetComplianceConfiguration

Set compliance configuration settings.

Arguments

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.

Example settings object:

{
  "adminEmailPreviewEnabled": true,
  "legalHoldEnabled": false,
  "logSuccessfulUserActivities": [
    "AdminRestored",
    "ComplianceChangeSettings",
    "FileGroupAttach",
    "FileGroupCreate",
    "FileGroupDetach",
    "FileGroupRename",
    "FileGroupSetProperties",
    "FileGroupSetRequestedState",
    "ProfileChangeUserName",
    "UserAdd",
    "UserDelete",
    "UserRename",
    "UserSetFolderAccess",
    "UserSetMappings",
    "UserUpdate"
  ]
}

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.

SetJobEnabled

Set enabled status of a job.

Arguments

Name	Type	Description
`instanceID`	string	Unique ID of MailStore instance in which this command is invoked.
`id`	number (optional)	The unique identifier of the job to be modified.
`enabled`	bool (optional)	Boolean value of enabled attribute.

SetJobSchedule

Modify the schedule of a job.

Arguments

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

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

Argument Values

interval

Name	Description
`5`	Every 5 minutes.
`10`	Every 10 minutes.
`15`	Every 15 minutes.
`20`	Every 20 minutes.
`30`	Every 30 minutes.
`60`	Every hour.
`120`	Every 2 hours.
`180`	Every 3 hours.
`260`	Every 4 hours.
`360`	Every 6 hours.
`720`	Every 12 hours.

dayOfWeek

Name	Description
`Sunday`	Sunday
`Monday`	Monday
`Tuesday`	Tuesday
`Wednesday`	Wednesday
`Thursday`	Thursday
`Friday`	Friday
`Saturday`	Saturday

dayOfMonth

Name	Description
`1 to 31`	Numeric representation of day of month.
`Last`	Last day of month.

SetSmtpSettings

Set SMTP configuration.

Arguments

Name	Type	Description
`instanceID`	string	Unique ID of MailStore instance in which this command is invoked.
`settings`	json	SMTP configuration.

Argument Values

settings

Example settings object:

{
  "hostname": "mail.example.com",
  "port": 587,
  "protocol": "SMTP-TLS",
  "ignoreSslPolicyErrors": false,
  "authenticationRequired": true,
  "username": "[email protected]",
  "password": "userpassword",
  "fromDisplayName": "Sending User",
  "fromEmailAddress": "[email protected]",
  "recipientEmailAddress": "[email protected]"
}

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

Argument Values

privileges

Name	Description
`none`	The user is granted no global privileges. If specified, this value has to be the only value in the list.
`admin`	The user is granted administrator privileges. If specified, this value has to be the only value in the list.
`login`	The user can log on to MailStore Server.
`changePassword`	The user can change his own MailStore Server password. This only makes sense if the authentication is set to integrated.
`archive`	The user can run archiving profiles.
`modifyArchiveProfiles`	The user can create, modify and delete archiving profiles.
`export`	The user can run export profiles.
`modifyExportProfiles`	The user can create, modify and delete export profiles.
`delete`	The user can delete messages. Please note that a non-admin user can only delete messages in folders where he has been granted delete access. In addition, compliance settings may be in effect, keeping administrators and users from deleting messages even if they have been granted the privilege to do so.

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.

Argument Values

privileges

Name	Description
`none`	The user is denied access to the specified folder. If specified, this value has to be the only value in the list. This effectively removes all privileges on the specified folder.
`read`	The user is granted read access to the specified folder.
`write`	The user is granted write access to the specified folder. Messages can be moved within an archive.
`delete`	The user is granted delete access to the specified folder.

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.

TestSmtpSettings

Test current SMTP configuration.

Arguments

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

@@ Line 260: / Line 260: @@
 {
    "userName" : string,
-   "fullName" : string
+   "fullName" : string,
+  "emailAddress" : string
 }
 </source>
@@ Line 399: / Line 400: @@
 == GetArchiveAdminEnabled ==
-Get currrent state of archive admin access.
+Get current state of archive admin access.
 === Arguments ===
@@ Line 588: / Line 589: @@
 == GetServiceStatus ==
 Get current status of all SPE services.
-== GetSmtpSettings ==
-Get current SMTP configuration.
-=== Arguments ===
-{| class="wikitable"
-! width=150px | Name
-! width=120px | Type
-! Description
-|-
-| <tt>instanceID</tt>
-| string
-| Unique ID of MailStore instance in which this command is invoked.
-|}
 == GetStoreAutoCreateConfiguration ==
@@ Line 616: / Line 603: @@
 | Unique ID of MailStore instance in which this command is invoked.
 |}
+== GetSystemSmtpConfiguration ==
+Get current system wide SMTP configuration.
 == GetStores ==
@@ Line 727: / Line 717: @@
 |}
-== RefreshAllStoreStatistics ==
+== RecoverStore ==
-Refresh archive store statistics.
+Recreates a broken Firebird database from recovery records. The archive store must have been upgraded to the latest version and the recovery records must not be corrupt. The archive store must be in the ''Disabled'' or ''Error'' state.
 === Arguments ===
@@ Line 737: / Line 727: @@
 |-
 | <tt>instanceID</tt>
 | string
 | Unique ID of MailStore instance in which this command is invoked.
+|-
+| <tt>id</tt>
+| number
+| Unique ID of archive store.
+|-
+| <tt>encryptionKey</tt>
+| string (optional)
+| Encryption key of the archive store.
 |}
-== RenameStore ==
+== RecreateRecoveryRecords ==
-Rename archvive store
+Recreates broken Recovery Records of an archive store. Use ''VerifyStore'' to verify the state of the Recovery Records.
 === Arguments ===
@@ Line 751: / Line 749: @@
 |-
 | <tt>instanceID</tt>
 | string
 | Unique ID of MailStore instance in which this command is invoked.
 |-
@@ Line 757: / Line 755: @@
 | number
 | Unique ID of archive store.
-|-
-| <tt>name</tt>
-| string
-| New name of archive store.
 |}
-== RestartInstances ==
+== RefreshAllStoreStatistics ==
-Restart one or multiple instances.
+Refresh archive store statistics.
 === Arguments ===
@@ Line 772: / Line 766: @@
 ! Description
 |-
-| <tt>instanceFilter</tt>
+| <tt>instanceID</tt>
 | string
-| Instance filter string.
+| Unique ID of MailStore instance in which this command is invoked.
 |}
-=== Argument Values ===
+== ReloadBranding ==
+Reloads the SPE branding information from the filesystem. Newly connected clients are getting the updated branding.
+== RenameStore ==
+Rename archive store
-==== instanceFilter ====
+=== Arguments ===
 {| class="wikitable"
-! width=270px | Name
+! width=150px | Name
+! width=120px | Type
 ! Description
 |-
-| <tt>*</tt>
+| <tt>instanceID</tt>
-| All instances
+| string
+| Unique ID of MailStore instance in which this command is invoked.
 |-
-| <tt>instance01 instance02 instance03</tt>
+| <tt>id</tt>
-| instance01, instance02 and instance03
+| number
+| Unique ID of archive store.
 |-
-| <tt>*instancehost01 *instancehost02</tt>
+| <tt>name</tt>
-| All instances on instancehost1 and instancehost2
+| string
-|-
+| New name of archive store.
-| <tt>* .running</tt>
-| All running instances
-|-
-| <tt>* .stopped</tt>
-| All stopped instances
 |}
-== RetryOpenStores ==
+== RestartInstances ==
-Retry opening stores that failed previously
+Restart one or multiple instances.
 === Arguments ===
@@ Line 809: / Line 805: @@
 ! Description
 |-
-| <tt>instanceID</tt>
+| <tt>instanceFilter</tt>
 | string
-| Unique ID of MailStore instance in which this command is invoked.
+| Instance filter string.
 |}
-== SelectAllStoreIndexesForRebuild ==
+=== Argument Values ===
-Select all archive store for rebuild.
-=== Arguments ===
+==== instanceFilter ====
 {| class="wikitable"
-! width=150px | Name
+! width=270px | Name
-! width=120px | Type
 ! Description
 |-
-| <tt>instanceID</tt>
+| <tt>*</tt>
-| string
+| All instances
-| Unique ID of MailStore instance in which this command is invoked.
+|-
+| <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
 |}
-== SetArchiveAdminEnabled ==
+== RepairStoreDatabase ==
-Enable or disable archive admin access.
+Tries to resolve certain issues with archive store databases (e.g. missing database indexes).
 === Arguments ===
@@ Line 841: / Line 846: @@
 | Unique ID of MailStore instance in which this command is invoked.
 |-
-| <tt>enabled</tt>
+| <tt>id</tt>
-| bool
+| number
-| Enable or disable flag.
+| Unique ID of archive store.
 |}
-== SetClientAccessServerConfiguration ==
+== RetryOpenStores ==
-Set the configuration of a Client Access Server.
+Retry opening stores that failed previously
 === Arguments ===
@@ Line 855: / Line 860: @@
 ! Description
 |-
-| <tt>config</tt>
+| <tt>instanceID</tt>
-| json
+| string
-| Client Access Server configuration.
+| Unique ID of MailStore instance in which this command is invoked.
 |}
-=== Argument Values ===
+== SelectAllStoreIndexesForRebuild ==
+Select all archive store for rebuild.
-==== config ====
-<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
-{
-  "serverName" : string,
-  "port" : number,
-  "serverCertificate" : {
-    "thumbprint" : string
-  }
-}
-</source>
-== SetIndexConfiguration ==
-Set full text search index configuration.
 === Arguments ===
@@ Line 885: / Line 877: @@
 | string
 | Unique ID of MailStore instance in which this command is invoked.
-|-
-| <tt>config</tt>
-| json
-| Full text search index configuration.
 |}
-=== Argument Values ===
+== SetArchiveAdminEnabled ==
+Enable or disable archive admin access.
-==== config ====
-Use GetIndexConfiguration to reveive supported value.
-== SetInstanceConfiguration ==
-Set configuration of MailStore Instance.
 === Arguments ===
@@ Line 905: / Line 888: @@
 ! Description
 |-
-| <tt>config</tt>
+| <tt>instanceID</tt>
-| json
+| string
-| Instance configuration.
+| Unique ID of MailStore instance in which this command is invoked.
+|-
+| <tt>enabled</tt>
+| bool
+| Enable or disable flag.
 |}
-=== Argument Values ===
+== SetClientAccessServerConfiguration ==
+Set the configuration of a Client Access Server.
-==== config ====
-<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
-{
-  "instanceID" : string,
-  "alias" : string,
-  "displayName" : string,
-  "instanceHost" : string,
-  "startMode" : string,
-  "baseDirectory" : string,
-  "debugLogEnabled" : bool,
-  "vssWriterEnabled" : bool
-}
-</source>
-== SetInstanceHostConfiguration ==
-Set configuration of Instance Host.
 === Arguments ===
@@ Line 937: / Line 908: @@
 | <tt>config</tt>
 | json
-| Instance Host configuration.
+| Client Access Server configuration.
 |}
@@ Line 949: / Line 920: @@
    "serverCertificate" : {
      "thumbprint" : string
-   },
+   }
-  "baseDirectory" : string
 }
 </source>
-== SetStoreAutoCreateConfiguration ==
+== SetIndexConfiguration ==
-Set configuration for automatic archive store creation.
+Set full text search index configuration.
 === Arguments ===
@@ Line 969: / Line 939: @@
 | <tt>config</tt>
 | json
-| Archive store automatic creation configuration.
+| Full text search index configuration.
 |}
@@ Line 975: / Line 945: @@
 ==== config ====
-<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
+Use GetIndexConfiguration to receive supported value.
-{
-  "enabled" : bool,
-  "interval" : string,
-  "sizeThreshold" : string,
-  "numberOfMessagesThreshold" : number,
-  "baseDirectory" : string
-}
-</source>
-== SetStorePath ==
+== SetInstanceConfiguration ==
-Set the path to archive store data.
+Set configuration of MailStore Instance.
 === Arguments ===
@@ Line 994: / Line 956: @@
 ! Description
 |-
-| <tt>instanceID</tt>
+| <tt>config</tt>
-| string
+| json
-| Unique ID of MailStore instance in which this command is invoked.
+| Instance configuration.
-|-
+|}
-| <tt>id</tt>
-| number
+=== Argument Values ===
-| Unique ID of archive store.
-|-
+==== config ====
-| <tt>path</tt>
+<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
-| string
+{
-| Path to archvie store data.
+  "instanceID" : string,
-|}
+  "alias" : string,
+  "displayName" : string,
+  "instanceHost" : string,
+  "startMode" : string,
+  "baseDirectory" : string,
+  "debugLogEnabled" : bool,
+  "vssWriterEnabled" : bool
+}
+</source>
-== SetStoreRequestedState ==
+== SetInstanceHostConfiguration ==
-Set state of archive store.
+Set configuration of Instance Host.
 === Arguments ===
@@ Line 1,016: / Line 986: @@
 ! Description
 |-
-| <tt>instanceID</tt>
+| <tt>config</tt>
-| string
+| json
-| Unique ID of MailStore instance in which this command is invoked.
+| Instance Host configuration.
-|-
-| <tt>id</tt>
-| number
-| Unique ID of archive store.
-|-
-| <tt>requestedState</tt>
-| string
-| State of archive store.
 |}
 === Argument Values ===
-==== requestedState ====
+==== config ====
+<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
+{
+  "serverName" : string,
+  "port" : number,
+  "serverCertificate" : {
+    "thumbprint" : string
+  },
+  "baseDirectory" : string
+}
+</source>
+== SetStoreAutoCreateConfiguration ==
+Set configuration for automatic archive store creation.
+=== Arguments ===
 {| class="wikitable"
-! width=270px | Name
+! width=150px | Name
+! width=120px | Type
 ! Description
 |-
-| <tt>current</tt>
+| <tt>instanceID</tt>
-| Same as Normal but new messages will be archived in the archive store that is set to Current.
+| string
-|-
+| Unique ID of MailStore instance in which this command is invoked.
-| <tt>normal</tt>
-| The content of archives store is available to users and can be modified if the user has the appropriate permission.
-|-
-| <tt>writeProtected</tt>
-| The content of write protected archive stores is available to users, but cannot be modified (e.g. delete or move messages, rename or move folders)
-|-
-| <tt>disabled</tt>
-| Disabled archive stores are not in use but the instance still knows about their existence. Therefore the content is not available to users.
-|}
-== SetSystemAdministratorConfiguration ==
-Set SPE system adminstrator configuration.
-=== Arguments ===
-{| class="wikitable"
-! width=150px | Name
-! width=120px | Type
-! Description
 |-
 | <tt>config</tt>
 | json
-| SPE system adminstrator configuration.
+| Archive store automatic creation configuration.
 |}
@@ Line 1,068: / Line 1,028: @@
 <source lang="js" smart-tabs="true" toolbar="false" gutter="false">
 {
-   "fullName" : string
+   "enabled" : bool,
+  "interval" : string,
+  "sizeThreshold" : string,
+  "numberOfMessagesThreshold" : number,
+  "baseDirectory" : string
 }
 </source>
-== SetSystemAdministratorPassword ==
+== SetStorePath ==
-Set password for SPE system administrator.
+Set the path to archive store data.
 === Arguments ===
@@ Line 1,081: / Line 1,045: @@
 ! Description
 |-
-| <tt>userName</tt>
+| <tt>instanceID</tt>
 | string
-| User name of SPE system administrator.
+| Unique ID of MailStore instance in which this command is invoked.
+|-
+| <tt>id</tt>
+| number
+| Unique ID of archive store.
 |-
-| <tt>password</tt>
+| <tt>path</tt>
 | string
-| New password for SPE system administrator.
+| Path to archive store data.
 |}
-== StartInstances ==
+== SetStoreRequestedState ==
-Start one or multiple MailStore Instances.
+Set state of archive store.
 === Arguments ===
@@ Line 1,099: / Line 1,067: @@
 ! Description
 |-
-| <tt>instanceFilter</tt>
+| <tt>instanceID</tt>
+| string
+| Unique ID of MailStore instance in which this command is invoked.
+|-
+| <tt>id</tt>
+| number
+| Unique ID of archive store.
+|-
+| <tt>requestedState</tt>
 | string
-| Instance filter string.
+| State of archive store.
 |}
 === Argument Values ===
-==== instanceFilter ====
+==== requestedState ====
 {| class="wikitable"
 ! width=270px | Name
 ! Description
 |-
-| <tt>*</tt>
+| <tt>current</tt>
-| All instances
+| Same as Normal but new messages will be archived in the archive store that is set to Current.
 |-
-| <tt>instance01 instance02 instance03</tt>
+| <tt>normal</tt>
-| instance01, instance02 and instance03
+| The content of archives store is available to users and can be modified if the user has the appropriate permission.
 |-
-| <tt>*instancehost01 *instancehost02</tt>
+| <tt>writeProtected</tt>
-| All instances on instancehost1 and instancehost2
+| 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>* .running</tt>
+| <tt>disabled</tt>
-| All running instances
+| Disabled archive stores are not in use but the instance still knows about their existence. Therefore the content is not available to users.
-|-
-| <tt>* .stopped</tt>
-| All stopped instances
 |}
-== StopInstances ==
+== SetSystemAdministratorConfiguration ==
-Stop one or multiple MailStore Instances.
+Set SPE system administrator configuration.
 === Arguments ===
@@ Line 1,136: / Line 1,109: @@
 ! Description
 |-
-| <tt>instanceFilter</tt>
+| <tt>config</tt>
-| string
+| json
-| Instance filter string.
+| SPE system administrator configuration.
 |}
 === Argument Values ===
-==== instanceFilter ====
+==== config ====
-{| class="wikitable"
+<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
-! width=270px | Name
+{
-! Description
+  "userName" : string,
-|-
+  "fullName" : string,
-| <tt>*</tt>
+  "emailAddress" : string
-| All instances
+}
-|-
+</source>
-| <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
-|}
-== ThawInstances ==
+== SetSystemAdministratorPassword ==
-Thaw one or multiple MailStore Instances.
+Set password for SPE system administrator.
 === Arguments ===
@@ Line 1,173: / Line 1,134: @@
 ! Description
 |-
-| <tt>instanceFilter</tt>
+| <tt>userName</tt>
 | string
-| Instance filter string.
+| User name of SPE system administrator.
-|}
-=== Argument Values ===
-==== instanceFilter ====
-{| class="wikitable"
-! width=270px | Name
-! Description
 |-
-| <tt>*</tt>
+| <tt>password</tt>
-| All instances
+| string
-|-
+| New password for SPE system administrator.
-| <tt>instance01 instance02 instance03</tt>
-| instance01, instance02 and instance03
-|-
-| <tt>*instancehost01 *instancehost02</tt>
-| All instances on instancehost1 and instancehost2
-|-
-| <tt>* .running</tt>
-| All running instances
-|-
-| <tt>* .stopped</tt>
-| All stopped instances
 |}
-== UpgradeStore ==
+== SetSystemSmtpConfiguration ==
-Upgrade archive store from MailStore Server 5 or older to current format.
+Set system wide SMTP configuration.
 === Arguments ===
@@ Line 1,210: / Line 1,152: @@
 ! Description
 |-
-| <tt>instanceID</tt>
+| <tt>config</tt>
-| string
+| json
-| Unique ID of MailStore instance in which this command is invoked.
+| SMTP configuration.
-|-
-| <tt>id</tt>
-| number
-| Unique ID of archive store.
 |}
-== VerifyStore ==
+=== Argument Values ===
-Verify archive stores consistency.
+==== config ====
+Example config object:
+<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
+{
+  "hostname": "mail.example.com",
+  "port": 587,
+  "protocol": "SMTP-TLS",
+  "ignoreSslPolicyErrors": false,
+  "authenticationRequired": true,
+  "username": "[email protected]",
+  "password": "userpassword",
+  "fromDisplayName": "Sending User",
+  "fromEmailAddress": "[email protected]",
+  "recipientSystemAdministrator": ["admin", "johndoe"]
+}
+</source>
+== StartInstances ==
+Start one or multiple MailStore Instances.
 === Arguments ===
@@ Line 1,228: / Line 1,185: @@
 ! Description
 |-
-| <tt>instanceID</tt>
+| <tt>instanceFilter</tt>
 | string
-| Unique ID of MailStore instance in which this command is invoked.
+| Instance filter string.
 |-
-| <tt>id</tt>
+| <tt>safeMode</tt>
-| number
+| bool (optional)
-| Unique ID of archive store.
+| Start instances in Safe Mode to perform maintenance.
 |}
-== VerifyStores ==
+=== Argument Values ===
-Verify consistency of all archive stores.
-=== Arguments ===
+==== instanceFilter ====
 {| class="wikitable"
-! width=150px | Name
+! width=270px | Name
-! width=120px | Type
 ! Description
 |-
-| <tt>instanceID</tt>
+| <tt>*</tt>
-| string
+| All instances
-| Unique ID of MailStore instance in which this command is invoked.
+|-
+| <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
 |}
-== CancelJobAsync ==
+== StopInstances ==
-Cancel a running job asynchronously.
+Stop one or multiple MailStore Instances.
 === Arguments ===
@@ Line 1,260: / Line 1,226: @@
 ! Description
 |-
-| <tt>instanceID</tt>
+| <tt>instanceFilter</tt>
 | string
-| Unique ID of MailStore instance in which this command is invoked.
+| Instance filter string.
-|-
-| <tt>id</tt>
-| number
-| The unique identifier of the job to be canceled.
 |}
-== ClearUserPrivilegesOnFolders ==
+=== Argument Values ===
-Removes all privileges of a user on all archive folders.
-=== Arguments ===
+==== instanceFilter ====
 {| class="wikitable"
-! width=150px | Name
+! width=270px | Name
-! width=120px | Type
 ! Description
 |-
-| <tt>instanceID</tt>
+| <tt>*</tt>
-| string
+| All instances
-| Unique ID of MailStore instance in which this command is invoked.
+|-
+| <tt>instance01 instance02 instance03</tt>
+| instance01, instance02 and instance03
+|-
+| <tt>*instancehost01 *instancehost02</tt>
+| All instances on instancehost1 and instancehost2
 |-
-| <tt>userName</tt>
+| <tt>* .running</tt>
-| string
+| All running instances
-| User name of MailStore user.
+|-
-|}
+| <tt>* .stopped</tt>
+| All stopped instances
-== CreateJob ==
+|}
-Create a new job to execute Management API commands.
+== TestSystemSmtpConfiguration ==
+Test current system wide SMTP configuration.
+== ThawInstances ==
+Thaw one or multiple MailStore Instances.
 === Arguments ===
@@ Line 1,296: / Line 1,266: @@
 ! Description
 |-
-| <tt>instanceID</tt>
+| <tt>instanceFilter</tt>
 | string
-| Unique ID of MailStore instance in which this command is invoked.
+| Instance filter string.
+|}
+=== Argument Values ===
+==== instanceFilter ====
+{| class="wikitable"
+! width=270px | Name
+! Description
 |-
-| <tt>name</tt>
+| <tt>*</tt>
-| string (optional)
+| All instances
-| A meaningful name for the job. Example: ''Daily Backup''.
 |-
-| <tt>action</tt>
+| <tt>instance01 instance02 instance03</tt>
-| string (optional)
+| instance01, instance02 and instance03
-| Management API command to execute.
 |-
-| <tt>owner</tt>
+| <tt>*instancehost01 *instancehost02</tt>
-| string (optional)
+| All instances on instancehost1 and instancehost2
-| Username of the job owner; must be an administrator.
 |-
-| <tt>timeZoneId</tt>
+| <tt>* .running</tt>
-| string (optional)
+| All running instances
-| The time zone the date should be converted to, e.g. ''$Local'', which represents the time zone of the operating system.
 |-
-| <tt>date</tt>
+| <tt>* .stopped</tt>
-| string (optional)
+| All stopped instances
-| Datetime string (YYYY-MM-DDThh:mm:ss) for running the job once.
+|}
+== UpgradeStore ==
+Upgrade archive store from MailStore Server 5 or older to current format.
+=== Arguments ===
+{| class="wikitable"
+! width=150px | Name
+! width=120px | Type
+! Description
 |-
-| <tt>interval</tt>
+| <tt>instanceID</tt>
-| number (optional)
+| string
-| Interval for running job.
+| Unique ID of MailStore instance in which this command is invoked.
 |-
-| <tt>time</tt>
+| <tt>id</tt>
-| string (optional)
+| number
-| Time for running job. Without additional parameter, this means daily execution.
+| Unique ID of archive store.
-|-
-| <tt>dayOfWeek</tt>
-| string (optional)
-| Day of week to run job. Parameter "time" also required.
-|-
-| <tt>dayOfMonth</tt>
-| string (optional)
-| Day of month to run job. Parameter "time" also required. dayOfWeek can optionally be used to define further.
 |}
-=== Argument Values ===
+== VerifyStore ==
+Verify archive stores consistency.
-==== interval ====
+=== Arguments ===
 {| class="wikitable"
-! width=270px | Name
+! width=150px | Name
+! width=120px | Type
 ! Description
 |-
-| <tt>5</tt>
+| <tt>instanceID</tt>
-| Every 5 minutes.
+| string
+| Unique ID of MailStore instance in which this command is invoked.
 |-
-| <tt>10</tt>
+| <tt>id</tt>
-| Every 10 minutes.
+| number
+| Unique ID of archive store.
 |-
-| <tt>15</tt>
+| <tt>includeIndexes</tt>
-| Every 15 minutes.
+| bool
+| Defines whether to verify the search indexes as well.
+|}
+== VerifyStores ==
+Verify consistency of all archive stores.
+=== Arguments ===
+{| class="wikitable"
+! width=150px | Name
+! width=120px | Type
+! Description
 |-
-| <tt>20</tt>
+| <tt>instanceID</tt>
-| Every 20 minutes.
+| string
+| Unique ID of MailStore instance in which this command is invoked.
 |-
-| <tt>30</tt>
+| <tt>includeIndexes</tt>
-| Every 30 minutes.
+| bool
-|-
+| Defines whether to verify the search indexes as well.
-| <tt>60</tt>
+|}
-| Every hour.
-|-
+== CancelJobAsync ==
-| <tt>120</tt>
+Cancel a running job asynchronously.
-| Every 2 hours.
-|-
-| <tt>180</tt>
-| Every 3 hours.
-|-
-| <tt>260</tt>
-| Every 4 hours.
-|-
-| <tt>360</tt>
-| Every 6 hours.
-|-
-| <tt>720</tt>
-| Every 12 hours.
-|}
-==== dayOfWeek ====
+=== Arguments ===
 {| class="wikitable"
-! width=270px | Name
+! width=150px | Name
+! width=120px | Type
 ! Description
 |-
-| <tt>Sunday</tt>
+| <tt>instanceID</tt>
-| Sunday
+| string
+| Unique ID of MailStore instance in which this command is invoked.
 |-
-| <tt>Monday</tt>
+| <tt>id</tt>
-| Monday
+| number
-|-
+| The unique identifier of the job to be canceled.
-| <tt>Tuesday</tt>
-| Tuesday
-|-
-| <tt>Wednesday</tt>
-| Wednesday
-|-
-| <tt>Thursday</tt>
-| Thursday
-|-
-| <tt>Friday</tt>
-| Friday
-|-
-| <tt>Saturday</tt>
-| Saturday
 |}
-==== dayOfMonth ====
+== ClearUserPrivilegesOnFolders ==
+Removes all privileges of a user on all archive folders.
+=== Arguments ===
 {| class="wikitable"
-! width=270px | Name
+! width=150px | Name
+! width=120px | Type
 ! Description
 |-
-| <tt>1 to 31</tt>
+| <tt>instanceID</tt>
-| Numeric represation of day of month.
+| string
+| Unique ID of MailStore instance in which this command is invoked.
 |-
-| <tt>Last</tt>
+| <tt>userName</tt>
-| Last day of month.
+| string
+| User name of MailStore user.
 |}
-== CreateProfile ==
+== CreateJob ==
-Create a new archiving or exporting profile.
+Create a new job to execute Management API commands.
 === Arguments ===
@@ Line 1,430: / Line 1,401: @@
 | Unique ID of MailStore instance in which this command is invoked.
 |-
-| <tt>properties</tt>
+| <tt>name</tt>
-| json
+| string (optional)
-| Profile properties.
+| A meaningful name for the job. Example: ''Daily Backup''.
+|-
+| <tt>action</tt>
+| string (optional)
+| Management API command to execute.
+|-
+| <tt>owner</tt>
+| string (optional)
+| Username of the job owner; must be an administrator.
 |-
-| <tt>raw</tt>
+| <tt>timeZoneId</tt>
-| bool
+| string (optional)
-| Currently only 'true' is supported.
+| The time zone id of the time zone the date should be converted to, e.g. $Local, which represents the time zone of the operating system.
-|}
-=== Argument Values ===
-==== properties ====
-To receive available profile properties create a profile of the desired type via MailStore Client and then use the GetProfiles method to receive supported values. The properties ''id'' and ''version'' must be omitted, the password field must be filled properly.
-== CreateUser ==
-Create new MailStore user.
-=== Arguments ===
-{| class="wikitable"
-! width=150px | Name
-! width=120px | Type
-! Description
 |-
-| <tt>instanceID</tt>
+| <tt>date</tt>
-| string
+| string (optional)
-| Unique ID of MailStore instance in which this command is invoked.
+| Datetime string (YYYY-MM-DDThh:mm:ss) for running the job once.
 |-
-| <tt>userName</tt>
+| <tt>interval</tt>
-| string
+| number (optional)
-| User name of new MailStore user.
+| Interval for running job.
 |-
-| <tt>privileges</tt>
+| <tt>time</tt>
-| string
-| Comma separated list of privileges.
-|-
-| <tt>fullName</tt>
 | string (optional)
-| Full name of user.
+| Time for running job. Without additional parameter, this means daily execution.
 |-
-| <tt>distinguishedName</tt>
+| <tt>dayOfWeek</tt>
 | string (optional)
-| LDAP DN string.
+| Day of week to run job. Parameter "time" also required.
 |-
-| <tt>authentication</tt>
+| <tt>dayOfMonth</tt>
 | string (optional)
-| Authentication setting for user: 'integrated' or 'directoryServices'.
+| Day of month to run job. Parameter "time" also required. dayOfWeek can optionally be used to define further.
-|-
-| <tt>password</tt>
-| string (optional)
-| Password of new user.
 |}
-== DeleteEmptyFolders ==
+Use the API command ''GetTimeZones'' to retrieve a list of all available time zones.
-Remove folders from folder tree that do not contain emails.
+=== Argument Values ===
-=== Arguments ===
+==== interval ====
 {| class="wikitable"
-! width=150px | Name
+! width=270px | Name
-! width=120px | Type
 ! Description
 |-
-| <tt>instanceID</tt>
+| <tt>5</tt>
-| string
+| Every 5 minutes.
-| Unique ID of MailStore instance in which this command is invoked.
 |-
-| <tt>folder</tt>
+| <tt>10</tt>
-| string (optional)
+| Every 10 minutes.
-| Entry point in folder tree.
-|}
-== DeleteJob ==
-Deletes a job.
-=== Arguments ===
-{| class="wikitable"
-! width=150px | Name
-! width=120px | Type
-! Description
 |-
-| <tt>instanceID</tt>
+| <tt>15</tt>
-| string
+| Every 15 minutes.
-| Unique ID of MailStore instance in which this command is invoked.
 |-
-| <tt>id</tt>
+| <tt>20</tt>
-| string (optional)
+| Every 20 minutes.
-| The uniqe identifier of the job to be deleted.
-|}
-== DeleteMessage ==
-Delete a single message
-=== Arguments ===
-{| class="wikitable"
-! width=150px | Name
-! width=120px | Type
-! Description
 |-
-| <tt>instanceID</tt>
+| <tt>30</tt>
-| string
+| Every 30 minutes.
-| Unique ID of MailStore instance in which this command is invoked.
+|-
+| <tt>60</tt>
+| Every hour.
+|-
+| <tt>120</tt>
+| Every 2 hours.
+|-
+| <tt>180</tt>
+| Every 3 hours.
+|-
+| <tt>240</tt>
+| Every 4 hours.
+|-
+| <tt>360</tt>
+| Every 6 hours.
 |-
-| <tt>id</tt>
+| <tt>720</tt>
-| string (optional)
+| Every 12 hours.
-| Unique ID of message. Format: <store_id>:<message_num>
 |}
-== DeleteProfile ==
+==== dayOfWeek ====
-Delete an archiving or exporting profile.
-=== Arguments ===
 {| class="wikitable"
-! width=150px | Name
+! width=270px | Name
-! width=120px | Type
 ! Description
 |-
-| <tt>instanceID</tt>
+| <tt>Sunday</tt>
-| string
+| Sunday
-| Unique ID of MailStore instance in which this command is invoked.
+|-
+| <tt>Monday</tt>
+| Monday
+|-
+| <tt>Tuesday</tt>
+| Tuesday
+|-
+| <tt>Wednesday</tt>
+| Wednesday
+|-
+| <tt>Thursday</tt>
+| Thursday
+|-
+| <tt>Friday</tt>
+| Friday
 |-
-| <tt>id</tt>
+| <tt>Saturday</tt>
-| number
+| Saturday
-| Unique ID of profile.
 |}
-== DeleteUser ==
+==== dayOfMonth ====
-Delete a MailStore user.
+{| class="wikitable"
+! width=270px | Name
-=== Arguments ===
+! Description
+|-
+| <tt>1 to 31</tt>
+| Numeric representation of day of month.
+|-
+| <tt>Last</tt>
+| Last day of month.
+|}
+== CreateProfile ==
+Create a new archiving or exporting profile.
+=== Arguments ===
 {| class="wikitable"
 ! width=150px | Name
@@ Line 1,567: / Line 1,532: @@
 | Unique ID of MailStore instance in which this command is invoked.
 |-
-| <tt>userName</tt>
+| <tt>properties</tt>
-| string
+| json
-| User name of MailStore user.
+| Profile properties.
+|-
+| <tt>raw</tt>
+| bool
+| Currently only 'true' is supported.
 |}
-== GetChildFolders ==
+=== Argument Values ===
-Get child folders.
+==== properties ====
+To receive available profile properties create a profile of the desired type via the Email Archive client and then use the GetProfiles method to receive supported values. The properties ''id'' and ''version'' must be omitted, the password field must be filled properly.
+== CreateUser ==
+Create new MailStore user. Use ''SetPrivilegesOnFolder'' to grant that user privileges on the own archive.
 === Arguments ===
@@ Line 1,585: / Line 1,559: @@
 | Unique ID of MailStore instance in which this command is invoked.
 |-
-| <tt>folder</tt>
+| <tt>userName</tt>
+| string
+| User name of new MailStore user.
+|-
+| <tt>privileges</tt>
+| string
+| Comma separated list of privileges.
+|-
+| <tt>fullName</tt>
+| string (optional)
+| Full name of user.
+|-
+| <tt>distinguishedName</tt>
+| string (optional)
+| LDAP DN string.
+|-
+| <tt>authentication</tt>
 | string (optional)
-| Parent folder.
+| Authentication setting for user: 'integrated' or 'directoryServices'.
 |-
-| <tt>maxLevels</tt>
+| <tt>password</tt>
-| number (optional)
+| string (optional)
-| Depth of child folders.
+| Password of new user.
 |}
-== GetComplianceConfiguration ==
+=== Argument Values ===
-Get current compliance configuration settings.
+==== privileges ====
+{{Template:Management_API_User_Privileges}}
+== DeleteEmptyFolders ==
+Remove folders from folder tree that do not contain emails.
 === Arguments ===
@@ Line 1,606: / Line 1,601: @@
 | string
 | Unique ID of MailStore instance in which this command is invoked.
+|-
+| <tt>folder</tt>
+| string (optional)
+| Entry point in folder tree.
 |}
-== GetDirectoryServicesConfiguration ==
+== DeleteJob ==
-Get current Directory Services configuration settings.
+Deletes a job.
 === Arguments ===
@@ Line 1,620: / Line 1,619: @@
 | string
 | Unique ID of MailStore instance in which this command is invoked.
+|-
+| <tt>id</tt>
+| string (optional)
+| The unique identifier of the job to be deleted.
 |}
-== GetFolderStatistics ==
+== DeleteProfile ==
-Get folder statistics.
+Delete an archiving or exporting profile.
 === Arguments ===
@@ Line 1,634: / Line 1,637: @@
 | string
 | Unique ID of MailStore instance in which this command is invoked.
+|-
+| <tt>id</tt>
+| number
+| Unique ID of profile.
 |}
-== GetJobResults ==
+== DeleteUser ==
-Retrieves list of finished job executions.
+Delete a MailStore user.
 === Arguments ===
@@ Line 1,649: / Line 1,656: @@
 | Unique ID of MailStore instance in which this command is invoked.
 |-
-| <tt>fromIncluding</tt>
+| <tt>userName</tt>
 | string
-| Beginning of time range to fetch.
+| User name of MailStore user.
+|}
+== GetChildFolders ==
+Get child folders.
+=== Arguments ===
+{| class="wikitable"
+! width=150px | Name
+! width=120px | Type
+! Description
 |-
-| <tt>toExcluding</tt>
+| <tt>instanceID</tt>
 | string
-| End of time range to fetch.
+| Unique ID of MailStore instance in which this command is invoked.
 |-
-| <tt>timeZoneId</tt>
+| <tt>folder</tt>
-| string
+| string (optional)
-| Time zone in which timestamp should be returned.
+| Parent folder.
 |-
-| <tt>JobId</tt>
+| <tt>maxLevels</tt>
 | number (optional)
-| The job id for which to retrieve results.
+| Depth of child folders.
 |}
-Interactive Management Shell Example: ''GetJobResults --instanceID="customer1" --fromIncluding="2016-12-01T00:00:00" --toExcluding="2016-12-31T23:59:59" --timeZoneId="$Local" --JobId=1''
+== GetComplianceConfiguration ==
+Get current compliance configuration settings.
-== GetJobs ==
-Retrieve list of jobs
 === Arguments ===
@@ Line 1,682: / Line 1,697: @@
 |}
-== GetMessages ==
+== GetDirectoryServicesConfiguration ==
-Get list of messages from a folder.
+Get current Directory Services configuration settings.
 === Arguments ===
@@ Line 1,694: / Line 1,709: @@
 | string
 | Unique ID of MailStore instance in which this command is invoked.
-|-
+|}
-| <tt>folder</tt>
-| string (optional)
-| Folder whose content to list.
-|}
-== GetProfiles ==
+== GetFolderStatistics ==
-Get list of archiving and exporting profiles.
+Get folder statistics.
 === Arguments ===
@@ Line 1,712: / Line 1,723: @@
 | string
 | Unique ID of MailStore instance in which this command is invoked.
-|-
-| <tt>raw</tt>
-| bool
-| Currently only 'true' is supported.
 |}
-== GetTimeZones ==
+== GetJobResults ==
-Get list of available time zones.
+Retrieves list of finished job executions.
 === Arguments ===
@@ Line 1,730: / Line 1,737: @@
 | string
 | Unique ID of MailStore instance in which this command is invoked.
-|}
-== GetUserInfo ==
-Get detailed information about user.
-=== Arguments ===
-{| class="wikitable"
-! width=150px | Name
-! width=120px | Type
-! Description
 |-
-| <tt>instanceID</tt>
+| <tt>fromIncluding</tt>
 | string
-| Unique ID of MailStore instance in which this command is invoked.
+| Beginning of time range to fetch.
 |-
-| <tt>userName</tt>
+| <tt>toExcluding</tt>
+| string
+| End of time range to fetch.
+|-
+| <tt>timeZoneId</tt>
 | string
-| User name of MailStore user
+| The time zone id of the time zone the date should be converted to, e.g. $Local, which represents the time zone of the operating system.
+|-
+| <tt>jobId</tt>
+| number (optional)
+| The job id for which to retrieve results.
 |}
-== GetUsers ==
+Interactive Management Shell Example: ''GetJobResults --fromIncluding="2016-12-01T00:00:00" --toExcluding="2016-12-31T23:59:59" --timeZoneId="$Local" --jobId=1''
-Get list of users.
+Use the API command ''GetTimeZones'' to retrieve a list of all available time zones.
+== GetJobs ==
+Retrieve list of jobs
 === Arguments ===
@@ Line 1,764: / Line 1,773: @@
 |}
-== GetWorkerResults ==
+== GetProfiles ==
-Get results of profile executions.
+Get list of archiving and exporting profiles.
 === Arguments ===
@@ Line 1,777: / Line 1,786: @@
 | Unique ID of MailStore instance in which this command is invoked.
 |-
-| <tt>fromIncluding</tt>
+| <tt>raw</tt>
-| string
+| bool
-| Beginning of time range to fetch.
+| Currently only 'true' is supported.
-|-
+|}
-| <tt>toExcluding</tt>
-| string
+== GetSmtpSettings ==
-| End of time range to fetch.
+Get current SMTP configuration.
+=== Arguments ===
+{| class="wikitable"
+! width=150px | Name
+! width=120px | Type
+! Description
 |-
-| <tt>timeZoneID</tt>
+| <tt>instanceID</tt>
 | string
-| Time zone in which timestamp should be returned.
+| Unique ID of MailStore instance in which this command is invoked.
-|-
-| <tt>profileID</tt>
-| number (optional)
-| Filter results by given profile ID.
-|-
-| <tt>userName</tt>
-| string (optional)
-| Filter results by given user name.
 |}
-== MoveFolder ==
+== GetTimeZones ==
-Move folder.
+Get list of available time zones.
 === Arguments ===
@@ Line 1,810: / Line 1,817: @@
 | string
 | Unique ID of MailStore instance in which this command is invoked.
-|-
+|}
-| <tt>fromFolder</tt>
-| string
+== GetUserInfo ==
-| Old folder name.
+Get detailed information about user.
-|-
-| <tt>toFolder</tt>
-| string
-| New folder name.
-|}
-== RenameJob ==
-Rename job.
 === Arguments ===
@@ Line 1,833: / Line 1,832: @@
 | Unique ID of MailStore instance in which this command is invoked.
 |-
-| <tt>id</tt>
+| <tt>userName</tt>
-| number (optional)
+| string
-| The unique identifier of the job to be renamed.
+| User name of MailStore user
-|-
-| <tt>name</tt>
-| string (optional)
-| The new job name.
 |}
-== RenameUser ==
+== GetUsers ==
-Rename a MailStore user.
+Get list of users.
 === Arguments ===
@@ Line 1,854: / Line 1,849: @@
 | string
 | Unique ID of MailStore instance in which this command is invoked.
-|-
+|}
-| <tt>oldUserName</tt>
-| string
+== GetWorkerResults ==
-| Old user name.
+Get results of profile executions.
-|-
-| <tt>newUserName</tt>
-| string
-| New user name.
-|}
-== RunJobAsync ==
-Run an existing job.
 === Arguments ===
@@ Line 1,877: / Line 1,864: @@
 | Unique ID of MailStore instance in which this command is invoked.
 |-
-| <tt>id</tt>
+| <tt>fromIncluding</tt>
-| number
+| string
-| The identifier of the job to be run.
+| Beginning of time range to fetch.
-|}
-== RunProfile ==
-Run an existing archiving or exporting profile.
-=== Arguments ===
-{| class="wikitable"
-! width=150px | Name
-! width=120px | Type
-! Description
 |-
-| <tt>instanceID</tt>
+| <tt>toExcluding</tt>
 | string
-| Unique ID of MailStore instance in which this command is invoked.
+| End of time range to fetch.
 |-
-| <tt>id</tt>
+| <tt>timeZoneID</tt>
-| number
+| string
-| Unique profile ID.
+| The time zone id of the time zone the date should be converted to, e.g. $Local, which represents the time zone of the operating system.
+|-
+| <tt>profileID</tt>
+| number (optional)
+| Filter results by given profile ID.
+|-
+| <tt>userName</tt>
+| string (optional)
+| Filter results by given user name.
 |}
-== RunTemporaryProfile ==
+Interactive Management Shell Example: ''GetWorkerResults --fromIncluding="2016-01-01T00:00:00" --toExcluding="2016-12-31T23:59:59" --timeZoneID="$Local" --profileID=1 --userName="admin"''
-Run a temporary/non-existent profile.
+Use the API command ''GetTimeZones'' to retrieve a list of all available time zones.
+== MoveFolder ==
+Move folder.
 === Arguments ===
@@ Line 1,913: / Line 1,902: @@
 | Unique ID of MailStore instance in which this command is invoked.
 |-
-| <tt>properties</tt>
+| <tt>fromFolder</tt>
-| json
+| string
-| Profile properties.
+| Old folder name.
 |-
-| <tt>raw</tt>
+| <tt>toFolder</tt>
-| bool
+| string
-| Currently only 'true' is supported.
+| New folder name.
 |}
-=== Argument Values ===
+== RenameJob ==
+Rename job.
-==== properties ====
-To receive available profile properties create a profile of the desired type via MailStore Client and use the GetProfiles method to receive supported value. ''Id'' and ''Version'' attributes must not be set.
-== SetComplianceConfiguration ==
-Set compliance configuration settings.
 === Arguments ===
@@ Line 1,940: / Line 1,924: @@
 | Unique ID of MailStore instance in which this command is invoked.
 |-
-| <tt>config</tt>
+| <tt>id</tt>
-| json
+| number (optional)
-| Compliance configuration.
+| The unique identifier of the job to be renamed.
+|-
+| <tt>name</tt>
+| string (optional)
+| The new job name.
 |}
-=== Argument Values ===
+== RenameUser ==
+Rename a MailStore user.
-==== config ====
-Use GetComplianceConfiguration to receive supported value.
-== SetDirectoryServicesConfiguration ==
-Set directory services configuration settings.
 === Arguments ===
@@ Line 1,963: / Line 1,946: @@
 | Unique ID of MailStore instance in which this command is invoked.
 |-
-| <tt>config</tt>
+| <tt>oldUserName</tt>
-| json
+| string
-| Directory services configuration.
+| Old user name.
+|-
+| <tt>newUserName</tt>
+| string
+| New user name.
 |}
-=== Argument Values ===
+== RunJobAsync ==
+Run an existing job.
-==== config ====
-Use GetDirectoryServicesConfiguration to receive supported value.
-== SetJobEnabled ==
-Set enabled status of a job.
 === Arguments ===
@@ Line 1,987: / Line 1,969: @@
 |-
 | <tt>id</tt>
-| number (optional)
+| number
-| The unique identifier of the job to be modified.
+| The identifier of the job to be run.
-|-
-| <tt>enabled</tt>
-| bool (optional)
-| Boolean value of '''enabled''' attribute.
 |}
-== SetJobSchedule ==
+== RunProfile ==
-Modify the schedule of a job.
+Run an existing archiving or exporting profile. Only profiles that are executed on server side can be started by this command. That are all profiles which are listed under ''E-Mail Servers'' in the E-Mail-Archive Client. Client side profiles can be started by using the ''MailStoreCmd'' and the commands ''import-execute'' and ''export-execute''.
 === Arguments ===
@@ Line 2,004: / Line 1,982: @@
 ! Description
 |-
-| <tt>id</tt>
+| <tt>instanceID</tt>
+| string
+| Unique ID of MailStore instance in which this command is invoked.
+|-
+| <tt>id</tt>
 | number
-| The unique identifier of the job to be modified.
+| Unique profile ID.
+|}
+== RunTemporaryProfile ==
+Run a temporary/non-existent profile. Only profiles that are executed on server side can be started by this command. That are all profiles which are listed under ''E-Mail Servers'' in the E-Mail-Archive Client.
+=== Arguments ===
+{| class="wikitable"
+! width=150px | Name
+! width=120px | Type
+! Description
 |-
-| <tt>timeZoneId</tt>
+| <tt>instanceID</tt>
 | string
-| The time zone the date should be converted to, e.g. ''$Local'', which represents the time zone of the operating system.
+| Unique ID of MailStore instance in which this command is invoked.
 |-
-| <tt>date</tt>
+| <tt>properties</tt>
-| string (optional)
+| json
-| Datetime string (YYYY-MM-DDThh:mm:ss) for running the job once.
+| Profile properties.
 |-
-| <tt>interval</tt>
+| <tt>raw</tt>
-| number (optional)
+| bool
-| Interval for running job.
+| Currently only 'true' is supported.
-|-
-| <tt>time</tt>
-| string (optional)
-| Time for running job. Without additional parameter, this means daily execution.
-|-
-| <tt>dayOfWeek</tt>
-| string (optional)
-| Day of week to run job. Parameter "time" also required.
-|-
-| <tt>dayOfMonth</tt>
-| string (optional)
-| Day of month to run job. Parameter "time" also required. dayOfWeek can optionally be used to define further.
 |}
 === Argument Values ===
-==== interval ====
+==== properties ====
+To receive available profile properties create a profile of the desired type via MailStore Client and use the GetProfiles method to receive supported value. ''Id'' and ''Version'' attributes must not be set.
+== SetComplianceConfiguration ==
+Set compliance configuration settings.
+=== Arguments ===
 {| class="wikitable"
-! width=270px | Name
+! width=150px | Name
+! width=120px | Type
 ! Description
 |-
-| <tt>5</tt>
+| <tt>instanceID</tt>
-| Every 5 minutes.
+| string
+| Unique ID of MailStore instance in which this command is invoked.
 |-
-| <tt>10</tt>
+| <tt>config</tt>
-| Every 10 minutes.
+| json
+| Compliance configuration.
+|}
+=== Argument Values ===
+==== config ====
+Use GetComplianceConfiguration to receive supported value.
+Example settings object:
+<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
+{
+  "adminEmailPreviewEnabled": true,
+  "legalHoldEnabled": false,
+  "logSuccessfulUserActivities": [
+    "AdminRestored",
+    "ComplianceChangeSettings",
+    "FileGroupAttach",
+    "FileGroupCreate",
+    "FileGroupDetach",
+    "FileGroupRename",
+    "FileGroupSetProperties",
+    "FileGroupSetRequestedState",
+    "ProfileChangeUserName",
+    "UserAdd",
+    "UserDelete",
+    "UserRename",
+    "UserSetFolderAccess",
+    "UserSetMappings",
+    "UserUpdate"
+  ]
+}
+</source>
+== SetDirectoryServicesConfiguration ==
+Set directory services configuration settings.
+=== Arguments ===
+{| class="wikitable"
+! width=150px | Name
+! width=120px | Type
+! Description
 |-
-| <tt>15</tt>
+| <tt>instanceID</tt>
-| Every 15 minutes.
+| string
+| Unique ID of MailStore instance in which this command is invoked.
 |-
-| <tt>20</tt>
+| <tt>config</tt>
-| Every 20 minutes.
+| json
+| Directory services configuration.
+|}
+=== Argument Values ===
+==== config ====
+Use GetDirectoryServicesConfiguration to receive supported value.
+== SetJobEnabled ==
+Set enabled status of a job.
+=== Arguments ===
+{| class="wikitable"
+! width=150px | Name
+! width=120px | Type
+! Description
 |-
-| <tt>30</tt>
+| <tt>instanceID</tt>
-| Every 30 minutes.
+| string
+| Unique ID of MailStore instance in which this command is invoked.
 |-
-| <tt>60</tt>
+| <tt>id</tt>
-| Every hour.
+| number (optional)
+| The unique identifier of the job to be modified.
 |-
-| <tt>120</tt>
+| <tt>enabled</tt>
-| Every 2 hours.
+| bool (optional)
-|-
+| Boolean value of '''enabled''' attribute.
-| <tt>180</tt>
-| Every 3 hours.
-|-
-| <tt>260</tt>
-| Every 4 hours.
-|-
-| <tt>360</tt>
-| Every 6 hours.
-|-
-| <tt>720</tt>
-| Every 12 hours.
 |}
-==== dayOfWeek ====
+== SetJobSchedule ==
+Modify the schedule of a job.
+=== Arguments ===
 {| class="wikitable"
-! width=270px | Name
+! width=150px | Name
+! width=120px | Type
 ! Description
 |-
-| <tt>Sunday</tt>
+| <tt>id</tt>
-| Sunday
+| number
+| The unique identifier of the job to be modified.
 |-
-| <tt>Monday</tt>
+| <tt>timeZoneId</tt>
-| Monday
+| string
+| The time zone id of the time zone the date should be converted to, e.g. $Local, which represents the time zone of the operating system.
 |-
-| <tt>Tuesday</tt>
+| <tt>date</tt>
-| Tuesday
+| string (optional)
+| Datetime string (YYYY-MM-DDThh:mm:ss) for running the job once.
 |-
-| <tt>Wednesday</tt>
+| <tt>interval</tt>
-| Wednesday
+| number (optional)
+| Interval for running job.
 |-
-| <tt>Thursday</tt>
+| <tt>time</tt>
-| Thursday
+| string (optional)
+| Time for running job. Without additional parameter, this means daily execution.
 |-
-| <tt>Friday</tt>
+| <tt>dayOfWeek</tt>
-| Friday
+| string (optional)
+| Day of week to run job. Parameter "time" also required.
 |-
-| <tt>Saturday</tt>
+| <tt>dayOfMonth</tt>
-| Saturday
+| string (optional)
+| Day of month to run job. Parameter "time" also required. dayOfWeek can optionally be used to define further.
 |}
-==== dayOfMonth ====
+Use the API command ''GetTimeZones'' to retrieve a list of all available time zones.
+=== Argument Values ===
+==== interval ====
 {| class="wikitable"
 ! width=270px | Name
 ! Description
 |-
-| <tt>1 to 31</tt>
+| <tt>5</tt>
-| Numeric represation of day of month.
+| Every 5 minutes.
+|-
+| <tt>10</tt>
+| Every 10 minutes.
 |-
-| <tt>Last</tt>
+| <tt>15</tt>
-| Last day of month.
+| Every 15 minutes.
-|}
-== SetSmtpSettings ==
-Set SMTP configuration.
-=== Arguments ===
-{| class="wikitable"
-! width=150px | Name
-! width=120px | Type
-! Description
 |-
-| <tt>instanceID</tt>
+| <tt>20</tt>
-| string
+| Every 20 minutes.
-| Unique ID of MailStore instance in which this command is invoked.
 |-
-| <tt>settings</tt>
+| <tt>30</tt>
-| json
+| Every 30 minutes.
-| SMTP configuration.
+|-
+| <tt>60</tt>
+| Every hour.
+|-
+| <tt>120</tt>
+| Every 2 hours.
+|-
+| <tt>180</tt>
+| Every 3 hours.
+|-
+| <tt>260</tt>
+| Every 4 hours.
+|-
+| <tt>360</tt>
+| Every 6 hours.
+|-
+| <tt>720</tt>
+| Every 12 hours.
 |}
-== SetUserAuthentication ==
+==== dayOfWeek ====
-Set authentication settings of a MailStore user.
-=== Arguments ===
 {| class="wikitable"
-! width=150px | Name
+! width=270px | Name
-! width=120px | Type
 ! Description
 |-
-| <tt>instanceID</tt>
+| <tt>Sunday</tt>
-| string
+| Sunday
-| Unique ID of MailStore instance in which this command is invoked.
+|-
+| <tt>Monday</tt>
+| Monday
+|-
+| <tt>Tuesday</tt>
+| Tuesday
+|-
+| <tt>Wednesday</tt>
+| Wednesday
+|-
+| <tt>Thursday</tt>
+| Thursday
 |-
-| <tt>userName</tt>
+| <tt>Friday</tt>
-| string
+| Friday
-| User name of MailStore user.
 |-
-| <tt>authentication</tt>
+| <tt>Saturday</tt>
-| string
+| Saturday
-| Authentication method. Either 'integrated' or 'directoryServices'.
 |}
-== SetUserDistinguishedName ==
+==== dayOfMonth ====
-Set the LDAP distinguished name of a MailStore user.
-=== Arguments ===
 {| class="wikitable"
-! width=150px | Name
+! width=270px | Name
-! width=120px | Type
 ! Description
 |-
-| <tt>instanceID</tt>
+| <tt>1 to 31</tt>
-| string
+| Numeric representation of day of month.
-| Unique ID of MailStore instance in which this command is invoked.
 |-
-| <tt>userName</tt>
+| <tt>Last</tt>
-| string
+| Last day of month.
-| User name of MailStore user.
-|-
-| <tt>distinguishedName</tt>
-| string (optional)
-| LDAP DN string.
 |}
-== SetUserEmailAddresses ==
+== SetSmtpSettings ==
-Set email addresses of MailStore user.
+Set SMTP configuration.
 === Arguments ===
@@ Line 2,188: / Line 2,243: @@
 | Unique ID of MailStore instance in which this command is invoked.
 |-
-| <tt>userName</tt>
+| <tt>settings</tt>
-| string
+| json
-| User name of MailStore user.
+| SMTP configuration.
-|-
-| <tt>emailAddresses</tt>
-| string (optional)
-| List of email addresses.
 |}
-== SetUserFullName ==
+=== Argument Values ===
-Set full name of MailStore user.
+==== settings====
+Example settings object:
+<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
+{
+  "hostname": "mail.example.com",
+  "port": 587,
+  "protocol": "SMTP-TLS",
+  "ignoreSslPolicyErrors": false,
+  "authenticationRequired": true,
+  "username": "[email protected]",
+  "password": "userpassword",
+  "fromDisplayName": "Sending User",
+  "fromEmailAddress": "[email protected]",
+  "recipientEmailAddress": "[email protected]"
+}
+</source>
+== SetUserAuthentication ==
+Set authentication settings of a MailStore user.
 === Arguments ===
@@ Line 2,214: / Line 2,285: @@
 | User name of MailStore user.
 |-
-| <tt>fullName</tt>
+| <tt>authentication</tt>
-| string (optional)
+| string
-| Full name of MailStore user.
+| Authentication method. Either 'integrated' or 'directoryServices'.
 |}
-== SetUserPassword ==
+== SetUserDistinguishedName ==
-Set password of MailStore user.
+Set the LDAP distinguished name of a MailStore user.
 === Arguments ===
@@ Line 2,236: / Line 2,307: @@
 | User name of MailStore user.
 |-
-| <tt>password</tt>
+| <tt>distinguishedName</tt>
-| string
+| string (optional)
-| Password of MailStore user.
+| LDAP DN string.
 |}
-== SetUserPop3UserNames ==
+== SetUserEmailAddresses ==
-Set POP3 user name of MailStore user.
+Set email addresses of MailStore user.
+=== Arguments ===
+{| class="wikitable"
+! width=150px | Name
+! width=120px | Type
+! Description
+|-
+| <tt>instanceID</tt>
+| string
+| Unique ID of MailStore instance in which this command is invoked.
+|-
+| <tt>userName</tt>
+| string
+| User name of MailStore user.
+|-
+| <tt>emailAddresses</tt>
+| string (optional)
+| List of email addresses.
+|}
+== SetUserFullName ==
+Set full name of MailStore user.
 === Arguments ===
@@ Line 2,258: / Line 2,351: @@
 | User name of MailStore user.
 |-
-| <tt>pop3UserNames</tt>
+| <tt>fullName</tt>
 | string (optional)
-| Comma seperated list of POP3 user names.
+| Full name of MailStore user.
 |}
-== SetUserPrivileges ==
+== SetUserPassword ==
-Set privileges of MailStore user.
+Set password of MailStore user.
 === Arguments ===
@@ Line 2,274: / Line 2,367: @@
 | <tt>instanceID</tt>
 | string
 | Unique ID of MailStore instance in which this command is invoked.
 |-
 | <tt>userName</tt>
 | string
 | User name of MailStore user.
 |-
-| <tt>privileges</tt>
+| <tt>password</tt>
 | string
-| Comma separated list of privileges.
+| Password of MailStore user.
 |}
-== SetUserPrivilegesOnFolder ==
+== SetUserPop3UserNames ==
-Set privileges on folder for MailStore user.
+Set POP3 user name of MailStore user.
 === Arguments ===
 {| class="wikitable"
 ! width=150px | Name
 ! width=120px | Type
+! Description
+|-
+| <tt>instanceID</tt>
+| string
+| Unique ID of MailStore instance in which this command is invoked.
+|-
+| <tt>userName</tt>
+| string
+| User name of MailStore user.
+|-
+| <tt>pop3UserNames</tt>
+| string (optional)
+| Comma separated list of POP3 user names.
+|}
+== SetUserPrivileges ==
+Set privileges of MailStore user.
+=== Arguments ===
+{| class="wikitable"
+! width=150px | Name
+! width=120px | Type
+! Description
+|-
+| <tt>instanceID</tt>
+| string
+| Unique ID of MailStore instance in which this command is invoked.
+|-
+| <tt>userName</tt>
+| string
+| User name of MailStore user.
+|-
+| <tt>privileges</tt>
+| string
+| Comma separated list of privileges.
+|}
+=== Argument Values ===
+==== privileges ====
+{{Template:Management_API_User_Privileges}}
+== SetUserPrivilegesOnFolder ==
+Set privileges on folder for MailStore user.
+=== Arguments ===
+{| class="wikitable"
+! width=150px | Name
+! width=120px | Type
+! Description
+|-
+| <tt>instanceID</tt>
+| string
+| Unique ID of MailStore instance in which this command is invoked.
+|-
+| <tt>userName</tt>
+| string
+| User name of MailStore user.
+|-
+| <tt>folder</tt>
+| string
+| Folder name.
+|-
+| <tt>privileges</tt>
+| string
+| Comma separated list of folder privileges.
+|}
+=== Argument Values ===
+==== privileges ====
+{| class="wikitable"
+! width=270px | Name
 ! Description
 |-
-| <tt>instanceID</tt>
+| <tt>none</tt>
-| string
+| The user is denied access to the specified folder. If specified, this value has to be the only value in the list. This effectively removes all privileges on the specified folder.
-| Unique ID of MailStore instance in which this command is invoked.
 |-
-| <tt>userName</tt>
+| <tt>read</tt>
-| string
+| The user is granted read access to the specified folder.
-| User name of MailStore user.
 |-
-| <tt>folder</tt>
+| <tt>write</tt>
-| string
+| The user is granted write access to the specified folder. Messages can be moved within an archive.
-| Folder name.
 |-
-| <tt>privileges</tt>
+| <tt>delete</tt>
-| string
+| The user is granted delete access to the specified folder.
-| Comma separated list of folder privileges.
 |}