Difference between revisions of "Management API - Function Reference"

[unchecked revision][checked revision]
 
(87 intermediate revisions by 5 users not shown)
Line 20: Line 20:
 
| Meaningful name of archive store.
 
| Meaningful name of archive store.
 
|-
 
|-
−
| <tt>path</tt>
+
| <tt>databasePath</tt>
 
| string  
 
| string  
−
| Path of directory containing archive store data.
+
| Path of the directory containing the archive store database. When it is the only given ''path'' argument, the values for ''contentPath'' and ''indexPath'' are determined automatically.
 +
|-
 +
| <tt>contentPath</tt>
 +
| string (optional)
 +
| Path of directory containing archive store content.
 +
|-
 +
| <tt>indexPath</tt>
 +
| string (optional)
 +
| Path of directory containing archive store index files.
 
|-
 
|-
 
| <tt>requestedState</tt>
 
| <tt>requestedState</tt>
Line 37: Line 45:
 
|-
 
|-
 
| <tt>current</tt>
 
| <tt>current</tt>
−
| Same as Normal but new messages will be archived in the archive store that is set to Current.
+
| Same as Normal, but new messages will be archived in the archive store that is set to Current.
 
|-
 
|-
 
| <tt>normal</tt>
 
| <tt>normal</tt>
Line 46: Line 54:
 
|-
 
|-
 
| <tt>disabled</tt>
 
| <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.
+
| Disabled archive stores are not in use, but the instance still knows about their existence. Therefore, the content is not available to users.
 
|}
 
|}
  
Line 156: Line 164:
 
   "baseDirectory" : string,
 
   "baseDirectory" : string,
 
   "debugLogEnabled" : bool,
 
   "debugLogEnabled" : bool,
−
   "vssWriterEnabled" : bool
+
  "imapServerConnectionLogEnabled" : bool,
 +
   "vssWriterEnabled" : bool,
 +
  "vssWriterExcludeIndexes" : bool,
 
}
 
}
 
</source>
 
</source>
 +
 +
=== Config Arguments ===
 +
 +
{| class="wikitable"
 +
! width=150px | Name
 +
! width=120px | Type
 +
! Description
 +
|-
 +
| <tt>instanceID</tt>
 +
| string
 +
| Possible characters are a-z, 0-9 and a dash (-). Only lower-case letters are allowed. The first character has to be a letter. The minimum length is 3 characters, the maximum length is 32 characters.
 +
|-
 +
| <tt>startMode</tt>
 +
| string
 +
| Possible values are ''automatic'', ''manual'', and ''disabled''. ''Automatic'' instances are started automatically with the Instance Host. ''Manual'' instances must be started manually. ''Disabled'' instances cannot be started at all.
 +
|}
  
 
== CreateInstanceHost ==
 
== CreateInstanceHost ==
Line 207: Line 233:
 
| Meaningful name of archive store.
 
| Meaningful name of archive store.
 
|-
 
|-
−
| <tt>path</tt>
+
| <tt>databasePath</tt>
 
| string  
 
| string  
−
| Path of directory containing archive store data.
+
| Path of the directory containing the archive store database. When it is the only given ''path'' argument, the values for ''contentPath'' and ''indexPath'' are determined automatically.
 +
|-
 +
| <tt>contentPath</tt>
 +
| string (optional)
 +
| Path of directory containing archive store content.
 +
|-
 +
| <tt>indexPath</tt>
 +
| string (optional)
 +
| Path of directory containing archive store index files.
 
|-
 
|-
 
| <tt>requestedState</tt>
 
| <tt>requestedState</tt>
Line 256: Line 290:
 
=== Argument Values ===
 
=== Argument Values ===
  
−
== DeleteClientAccessServer ==
+
==== config ====
−
Delete Client Access Server from management database.
+
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
 +
{
 +
  "userName" : string,
 +
  "fullName" : string,
 +
  "emailAddress" : string
 +
}
 +
</source>
 +
 
 +
== CreateSystemAdministratorAPIPassword==
 +
Creates and returns the API passsword of the user that executes this API command.
 +
Every SPE administrator has their own API password. Any previously created API password for this administrator is overwritten and therefore invalidated.
 +
 
 +
== DeactivateSystemAdministratorMFA ==
 +
Deactivates Multi-Factor Authentication for SPE system administrator.
 +
 
 +
=== Arguments ===
 +
{| class="wikitable"
 +
! width=150px | Name
 +
! width=120px | Type
 +
! Description
 +
|-
 +
| <tt>userName</tt>
 +
| string
 +
| User name of SPE system administrator.
 +
|}
 +
 
 +
== DeleteClientAccessServer ==
 +
Delete Client Access Server from management database.
  
 
=== Arguments ===
 
=== Arguments ===
Line 391: Line 452:
  
 
== GetArchiveAdminEnabled ==
 
== GetArchiveAdminEnabled ==
−
Get currrent state of archive admin access.
+
Get current state of archive admin access.
  
 
=== Arguments ===
 
=== Arguments ===
Line 423: Line 484:
  
 
=== Argument Values ===
 
=== Argument Values ===
 +
 +
==== serverNameFilter ====
 +
{| class="wikitable"
 +
! width=270px | Name
 +
! Description
 +
|-
 +
| <tt>null</tt>
 +
| All servers
 +
|-
 +
| <tt>serverName</tt>
 +
| Only the given serverName. Must match exactly.
 +
|}
  
 
== GetDirectoriesOnInstanceHost ==
 
== GetDirectoriesOnInstanceHost ==
Line 582: Line 655:
 
| Unique ID of MailStore instance in which this command is invoked.
 
| Unique ID of MailStore instance in which this command is invoked.
 
|}
 
|}
 +
 +
== GetSystemSmtpConfiguration ==
 +
Get current system wide SMTP configuration.
  
 
== GetStores ==
 
== GetStores ==
Line 595: Line 671:
 
| string  
 
| string  
 
| Unique ID of MailStore instance in which this command is invoked.
 
| Unique ID of MailStore instance in which this command is invoked.
 +
|-
 +
| <tt>includeSize</tt>
 +
| bool (optional)
 +
| Includes size of archive store. Default: ''true''. May be slow when running on slow hardware.
 
|}
 
|}
  
 
== GetSystemAdministrators ==
 
== GetSystemAdministrators ==
 
Get list of system administrators.
 
Get list of system administrators.
 +
The list contains the name, the full name, the email address and the Multi-Factor Authentication status.
 +
 +
== InitializeSystemAdministratorMFA ==
 +
Initializes Multi-Factor Authentication for SPE system administrator.
 +
The administrator has to finalize the setup of MFA on the next login at the Management Console.
 +
 +
=== Arguments ===
 +
{| class="wikitable"
 +
! width=150px | Name
 +
! width=120px | Type
 +
! Description
 +
|-
 +
| <tt>userName</tt>
 +
| string
 +
| User name of SPE system administrator.
 +
|}
  
 
== MaintainFileSystemDatabases ==
 
== MaintainFileSystemDatabases ==
Line 663: Line 759:
  
 
=== Argument Values ===
 
=== Argument Values ===
 +
 +
==== serverType ====
 +
{| class="wikitable"
 +
! width=270px | Name
 +
! Description
 +
|-
 +
| <tt>instanceHost</tt>
 +
| Pairing an Instance Host.
 +
|-
 +
| <tt>clientAccessServer</tt>
 +
| Pairing a Client Access Server.
 +
|}
  
 
== Ping ==
 
== Ping ==
Line 681: Line 789:
 
|}
 
|}
  
−
== 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 ===
 
=== Arguments ===
Line 691: Line 799:
 
|-
 
|-
 
| <tt>instanceID</tt>
 
| <tt>instanceID</tt>
−
| string  
+
| string
 
| Unique ID of MailStore instance in which this command is invoked.
 
| Unique ID of MailStore instance in which this command is invoked.
 +
|-
 +
| <tt>id</tt>
 +
| number
 +
| Unique ID of archive store.
 +
|-
 +
| <tt>encryptionKey</tt>
 +
| string (optional)
 +
| Encryption key of the archive store. Must be given, when the encryption key cannot be read from the key file of the archive store.
 +
|-
 +
| <tt>recoverDeletedMessages</tt>
 +
| bool (optional)
 +
| Defines whether to recover deleted messages.
 
|}
 
|}
  
−
== RenameStore ==
+
When the ''recoverDeletedMessages'' parameter is set to ''true'', only deleted messages that still have leftovers in the recovery records can be recovered. When an archive store has been compacted with [[#CompactStore|CompactStore]] or recovery record files have grown to their auto-compacting size of 32 MiB these leftovers could already be removed and deleted messages cannot be recovered.
−
Rename archvive store
+
 
 +
== RecreateRecoveryRecords ==
 +
Recreates broken Recovery Records of an archive store. Use [[#VerifyStore|VerifyStore]] or [[#VerifyStores|VerifyStores]] to verify the state of the Recovery Records.
 +
 
 +
=== Arguments ===
 +
{| class="wikitable"
 +
! width=150px | Name
 +
! width=120px | Type
 +
! Description
 +
|-
 +
| <tt>instanceID</tt>
 +
| string
 +
| Unique ID of MailStore instance in which this command is invoked.
 +
|-
 +
| <tt>id</tt>
 +
| number
 +
| Unique ID of archive store.
 +
|}
 +
 
 +
== RefreshAllStoreStatistics ==
 +
Refresh archive store statistics.
 +
 
 +
=== Arguments ===
 +
{| class="wikitable"
 +
! width=150px | Name
 +
! width=120px | Type
 +
! Description
 +
|-
 +
| <tt>instanceID</tt>
 +
| string
 +
| Unique ID of MailStore instance in which this command is invoked.
 +
|}
 +
 
 +
== ReloadBranding ==
 +
Reloads the SPE branding information from the filesystem. Newly connected clients are getting the updated branding.
 +
 
 +
== RenameStore ==
 +
Rename archive store
  
 
=== Arguments ===
 
=== Arguments ===
Line 752: Line 909:
 
| <tt>* .stopped</tt>
 
| <tt>* .stopped</tt>
 
| All stopped instances
 
| All stopped instances
 +
|}
 +
 +
== RepairStoreDatabase ==
 +
Tries to resolve certain issues with archive store databases (e.g. missing database indexes).
 +
 +
=== Arguments ===
 +
{| class="wikitable"
 +
! width=150px | Name
 +
! width=120px | Type
 +
! Description
 +
|-
 +
| <tt>instanceID</tt>
 +
| string
 +
| Unique ID of MailStore instance in which this command is invoked.
 +
|-
 +
| <tt>id</tt>
 +
| number
 +
| Unique ID of archive store.
 
|}
 
|}
  
Line 848: Line 1,023:
  
 
==== config ====
 
==== config ====
−
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
+
Use GetIndexConfiguration to receive supported value.
−
UseGetIndexConfigurationtoreveivesupportedvalue.
 
−
</source>
 
  
 
== SetInstanceConfiguration ==
 
== SetInstanceConfiguration ==
Line 933: Line 1,106:
 
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
 
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
 
{
 
{
−
   "enabled" : bool,
+
   "sizeThreshold" : string or null,
−
   "interval" : string,
+
   "baseDirectory" : string,
−
   "sizeThreshold" : string,
+
   "contentBaseDirectory" : string,
−
   "numberOfMessagesThreshold" : number,
+
   "indexBaseDirectory" : string
−
  "baseDirectory" : string
 
 
}
 
}
 
</source>
 
</source>
Line 958: Line 1,130:
 
| Unique ID of archive store.
 
| Unique ID of archive store.
 
|-
 
|-
−
| <tt>path</tt>
+
| <tt>databasePath</tt>
 
| string  
 
| string  
−
| Path to archvie store data.
+
| Path of the directory containing the archive store database. When it is the only given ''path'' argument, the values for ''contentPath'' and ''indexPath'' are determined automatically.
 +
|-
 +
| <tt>contentPath</tt>
 +
| string (optional)
 +
| Path of directory containing archive store content.
 +
|-
 +
| <tt>indexPath</tt>
 +
| string (optional)
 +
| Path of directory containing archive store index files.
 +
|-
 
|}
 
|}
  
Line 1,006: Line 1,187:
  
 
== SetSystemAdministratorConfiguration ==
 
== SetSystemAdministratorConfiguration ==
−
Set SPE system adminstrator configuration.
+
Set SPE system administrator configuration.
  
 
=== Arguments ===
 
=== Arguments ===
Line 1,016: Line 1,197:
 
| <tt>config</tt>
 
| <tt>config</tt>
 
| json  
 
| json  
−
| SPE system adminstrator configuration.
+
| SPE system administrator configuration.
 
|}
 
|}
  
Line 1,024: Line 1,205:
 
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
 
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
 
{
 
{
−
   "fullName" : string
+
  "userName" : string,
 +
   "fullName" : string,
 +
  "emailAddress" : string
 
}
 
}
 
</source>
 
</source>
Line 1,046: Line 1,229:
 
|}
 
|}
  
−
== StartInstances ==
+
== SetSystemSmtpConfiguration ==
−
Start one or multiple MailStore Instances.
+
Set system wide SMTP configuration.
  
 
=== Arguments ===
 
=== Arguments ===
Line 1,055: Line 1,238:
 
! Description
 
! Description
 
|-
 
|-
−
| <tt>instanceFilter</tt>
+
| <tt>config</tt>
 +
| json
 +
| SMTP configuration.
 +
|}
 +
 
 +
=== Argument Values ===
 +
 
 +
==== config ====
 +
Example config object:
 +
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
 +
{
 +
  "hostname": "mail.example.com",
 +
  "port": 587,
 +
  "protocol": "SMTP-TLS",
 +
  "ignoreSslPolicyErrors": false,
 +
  "authenticationRequired": true,
 +
  "username": "[email protected]",
 +
  "password": "userpassword",
 +
  "fromDisplayName": "Sending User",
 +
  "fromEmailAddress": "[email protected]",
 +
  "recipientSystemAdministrator": ["admin", "johndoe"]
 +
}
 +
</source>
 +
 
 +
== StartInstances ==
 +
Start one or multiple MailStore Instances.
 +
 
 +
=== Arguments ===
 +
{| class="wikitable"
 +
! width=150px | Name
 +
! width=120px | Type
 +
! Description
 +
|-
 +
| <tt>instanceFilter</tt>
 
| string  
 
| string  
 
| Instance filter string.
 
| Instance filter string.
 +
|-
 +
| <tt>safeMode</tt>
 +
| bool (optional)
 +
| Start instances in Safe Mode to perform maintenance.
 
|}
 
|}
  
Line 1,119: Line 1,339:
 
| All stopped instances
 
| All stopped instances
 
|}
 
|}
 +
 +
== TestSystemSmtpConfiguration ==
 +
Test current system wide SMTP configuration.
  
 
== ThawInstances ==
 
== ThawInstances ==
Line 1,158: Line 1,381:
  
 
== UpgradeStore ==
 
== UpgradeStore ==
−
Upgrade archive store from MailStore Server 5 or older to current format.
+
Upgrade an archive store from an older version to the current format.
  
 
=== Arguments ===
 
=== Arguments ===
Line 1,175: Line 1,398:
 
|}
 
|}
  
−
== VerifyStore ==
+
== UpgradeStores ==
−
Verify archive stores consistency.
+
Upgrade all archive stores from an older version to the current format.
  
 
=== Arguments ===
 
=== Arguments ===
Line 1,187: Line 1,410:
 
| string  
 
| string  
 
| Unique ID of MailStore instance in which this command is invoked.
 
| Unique ID of MailStore instance in which this command is invoked.
−
|-
 
−
| <tt>id</tt>
 
−
| number
 
−
| Unique ID of archive store.
 
 
|}
 
|}
  
−
== ClearUserPrivilegesOnFolders ==
+
== VerifyStore ==
−
Removes all privileges of a user on all archive folders.
+
Verify archive stores consistency.
  
 
=== Arguments ===
 
=== Arguments ===
Line 1,206: Line 1,425:
 
| Unique ID of MailStore instance in which this command is invoked.
 
| Unique ID of MailStore instance in which this command is invoked.
 
|-
 
|-
−
| <tt>userName</tt>
+
| <tt>id</tt>
−
| string
+
| number
−
| User name of MailStore user.
+
| Unique ID of archive store.
 +
|-
 +
| <tt>includeIndexes</tt>
 +
| bool
 +
| Defines whether to verify the search indexes as well. Default: true. May be slow when running on slow hardware.
 
|}
 
|}
  
−
== CreateProfile ==
+
== VerifyStores ==
−
Create a new archiving or exporting profile.
+
Verify consistency of all archive stores.
  
 
=== Arguments ===
 
=== Arguments ===
Line 1,224: Line 1,447:
 
| Unique ID of MailStore instance in which this command is invoked.
 
| Unique ID of MailStore instance in which this command is invoked.
 
|-
 
|-
−
| <tt>properties</tt>
+
| <tt>includeIndexes</tt>
−
| json
+
| bool
−
| Profile properties.
+
| Defines whether to verify the search indexes as well. Default: true. May be slow when running on slow hardware.
−
|-
 
−
| <tt>raw</tt>
 
−
| bool
 
−
| Currently only 'true' is supported.
 
 
|}
 
|}
  
−
=== Argument Values ===
+
== CancelJobAsync ==
−
 
+
Cancel a running job asynchronously.
−
== CreateUser ==
 
−
Create new MailStore user.
 
  
 
=== Arguments ===
 
=== Arguments ===
Line 1,248: Line 1,465:
 
| Unique ID of MailStore instance in which this command is invoked.
 
| Unique ID of MailStore instance in which this command is invoked.
 
|-
 
|-
−
| <tt>userName</tt>
+
| <tt>id</tt>
−
| string
+
| number
−
| User name of new MailStore user.
+
| The unique identifier of the job to be canceled.
−
|-
+
|}
−
| <tt>privileges</tt>
+
 
−
| string
+
== ClearUserPrivilegesOnFolders ==
−
| Comma separated list of privileges.
+
Removes all privileges of a user on all archive folders.
−
|-
 
−
| <tt>fullName</tt>
 
−
| string (optional)
 
−
| Full name of user.
 
−
|-
 
−
| <tt>distinguishedName</tt>
 
−
| string (optional)
 
−
| LDAP DN string.
 
−
|-
 
−
| <tt>authentication</tt>
 
−
| string (optional)
 
−
| Authentication setting for user: 'Standard' or 'DirectoryService'.
 
−
|-
 
−
| <tt>password</tt>
 
−
| string (optional)
 
−
| Password of new user.
 
−
|}
 
−
 
 
−
== DeleteEmptyFolders ==
 
−
Remove folders from folder tree that do not contain emails.
 
  
 
=== Arguments ===
 
=== Arguments ===
Line 1,286: Line 1,483:
 
| Unique ID of MailStore instance in which this command is invoked.
 
| Unique ID of MailStore instance in which this command is invoked.
 
|-
 
|-
−
| <tt>folder</tt>
+
| <tt>userName</tt>
−
| string (optional)
+
| string  
−
| Entry point in folder tree.
+
| User name of MailStore user.
 
|}
 
|}
  
−
== DeleteMessage ==
+
== CreateJob ==
−
Delete a single message
+
Create a new job to execute Management API commands.
  
 
=== Arguments ===
 
=== Arguments ===
Line 1,304: Line 1,501:
 
| Unique ID of MailStore instance in which this command is invoked.
 
| Unique ID of MailStore instance in which this command is invoked.
 
|-
 
|-
−
| <tt>id</tt>
+
| <tt>name</tt>
 
| string (optional)
 
| string (optional)
−
| Unique ID of message. Format: <store_id>:<message_num>
+
| A meaningful name for the job. Example: ''Daily Backup''.
−
|}
+
|-
 +
| <tt>action</tt>
 +
| string (optional)
 +
| Management API command to execute.
 +
|-
 +
| <tt>owner</tt>
 +
| string (optional)
 +
| Username of the job owner; must be an administrator.
 +
|-
 +
| <tt>timeZoneId</tt>
 +
| string (optional)
 +
| The time zone id of the time zone the date should be converted to, e.g. $Local, which represents the time zone of the operating system.
 +
|-
 +
| <tt>date</tt>
 +
| string (optional)
 +
| Datetime string (YYYY-MM-DDThh:mm:ss) for running the job once.
 +
|-
 +
| <tt>interval</tt>
 +
| number (optional)
 +
| Interval for running job.
 +
|-
 +
| <tt>time</tt>
 +
| string (optional)
 +
| Time for running job. Without additional parameter, this means daily execution.
 +
|-
 +
| <tt>dayOfWeek</tt>
 +
| string (optional)
 +
| Day of week to run job. Parameter "time" also required.
 +
|-
 +
| <tt>dayOfMonth</tt>
 +
| string (optional)
 +
| Day of month to run job. Parameter "time" also required. dayOfWeek can optionally be used to define further.
 +
|}
  
−
== DeleteProfile ==
+
Use the API command [[Management_API_-_Function_Reference#GetTimeZones|GetTimeZones]] to retrieve a list of all available time zones.
−
Delete an archiving or exporting profile.
+
=== Argument Values ===
  
−
=== Arguments ===
+
==== interval ====
 
{| class="wikitable"
 
{| class="wikitable"
−
! width=150px | Name
+
! width=270px | Name
−
! width=120px | Type
 
 
! Description
 
! Description
 
|-
 
|-
−
| <tt>instanceID</tt>
+
| <tt>5</tt>
−
| string
+
| Every 5 minutes.
−
| Unique ID of MailStore instance in which this command is invoked.
+
|-
 +
| <tt>10</tt>
 +
| Every 10 minutes.
 +
|-
 +
| <tt>15</tt>
 +
| Every 15 minutes.
 +
|-
 +
| <tt>20</tt>
 +
| Every 20 minutes.
 
|-
 
|-
−
| <tt>id</tt>
+
| <tt>30</tt>
−
| number
+
| Every 30 minutes.
−
| Unique ID of profile.
+
|-
 +
| <tt>60</tt>
 +
| Every hour.
 +
|-
 +
| <tt>120</tt>
 +
| Every 2 hours.
 +
|-
 +
| <tt>180</tt>
 +
| Every 3 hours.
 +
|-
 +
| <tt>240</tt>
 +
| Every 4 hours.
 +
|-
 +
| <tt>360</tt>
 +
| Every 6 hours.
 +
|-
 +
| <tt>720</tt>
 +
| Every 12 hours.
 +
|}
 +
 
 +
==== dayOfWeek ====
 +
{| class="wikitable"
 +
! width=270px | Name
 +
! Description
 +
|-
 +
| <tt>Sunday</tt>
 +
| Sunday
 +
|-
 +
| <tt>Monday</tt>
 +
| Monday
 +
|-
 +
| <tt>Tuesday</tt>
 +
| Tuesday
 +
|-
 +
| <tt>Wednesday</tt>
 +
| Wednesday
 +
|-
 +
| <tt>Thursday</tt>
 +
| Thursday
 +
|-
 +
| <tt>Friday</tt>
 +
| Friday
 +
|-
 +
| <tt>Saturday</tt>
 +
| Saturday
 +
|}
 +
 
 +
==== dayOfMonth ====
 +
{| class="wikitable"
 +
! width=270px | Name
 +
! Description
 +
|-
 +
| <tt>1 to 31</tt>
 +
| Numeric representation of day of month.
 +
|-
 +
| <tt>Last</tt>
 +
| Last day of month.
 
|}
 
|}
  
−
== DeleteUser ==
+
== CreateProfile ==
−
Delete a MailStore user.
+
Create a new archiving or exporting profile.
  
 
=== Arguments ===
 
=== Arguments ===
Line 1,340: Line 1,632:
 
| Unique ID of MailStore instance in which this command is invoked.
 
| 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 [[#SetUserPrivilegesOnFolder|SetUserPrivilegesOnFolder]] to grant that user privileges on the own archive.
  
 
=== Arguments ===
 
=== Arguments ===
Line 1,358: Line 1,659:
 
| Unique ID of MailStore instance in which this command is invoked.
 
| 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)
 
| string (optional)
−
| Parent folder.
+
| Full name of user.
 
|-
 
|-
−
| <tt>maxLevels</tt>
+
| <tt>distinguishedName</tt>
−
| number (optional)
+
| string (optional)
−
| Depth of child folders.
+
| LDAP DN string.
 +
|-
 +
| <tt>authentication</tt>
 +
| string (optional)
 +
| Authentication setting for user: 'integrated' or 'directoryServices'.
 +
|-
 +
| <tt>password</tt>
 +
| string (optional)
 +
| Password of new user.
 +
|-
 +
| <tt>loginPrivileges</tt>
 +
| string (optional)
 +
| Comma separated list of log in privileges. If not given, all login privileges are assigned.
 
|}
 
|}
  
−
== GetComplianceConfiguration ==
+
=== Argument Values ===
−
Get current compliance configuration settings.
+
 
 +
==== privileges ====
 +
{{Template:Management_API_User_Privileges}}
 +
 
 +
==== loginPrivileges ====
 +
{{Template:Management_API_User_Login_Privileges}}
 +
 
 +
== DeleteAppPasswords ==
 +
Deletes all app passwords of a user, hence all non-interactive logins will fail and have to be reconfigured by the user.
  
 
=== Arguments ===
 
=== Arguments ===
Line 1,379: Line 1,708:
 
| string  
 
| string  
 
| Unique ID of MailStore instance in which this command is invoked.
 
| Unique ID of MailStore instance in which this command is invoked.
 +
|-
 +
| <tt>userName</tt>
 +
| string
 +
| The user name of the user whose app passwords shall be deleted.
 
|}
 
|}
  
−
== GetDirectoryServicesConfiguration ==
+
== DeleteEmptyFolders ==
−
Get current Directory Services configuration settings.
+
Remove folders from folder tree that do not contain emails.
  
 
=== Arguments ===
 
=== Arguments ===
Line 1,393: Line 1,726:
 
| string  
 
| string  
 
| Unique ID of MailStore instance in which this command is invoked.
 
| Unique ID of MailStore instance in which this command is invoked.
 +
|-
 +
| <tt>folder</tt>
 +
| string (optional)
 +
| Entry point in folder tree.
 
|}
 
|}
  
−
== GetFolderStatistics ==
+
== DeleteJob ==
−
Get folder statistics.
+
Deletes a job.
  
 
=== Arguments ===
 
=== Arguments ===
Line 1,407: Line 1,744:
 
| string  
 
| string  
 
| Unique ID of MailStore instance in which this command is invoked.
 
| 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.
 +
|}
  
−
== GetMessages ==
+
== DeleteProfile ==
−
Get list of messages from a folder.
+
Delete an archiving or exporting profile.
  
 
=== Arguments ===
 
=== Arguments ===
Line 1,422: Line 1,763:
 
| Unique ID of MailStore instance in which this command is invoked.
 
| Unique ID of MailStore instance in which this command is invoked.
 
|-
 
|-
−
| <tt>folder</tt>
+
| <tt>id</tt>
−
| string (optional)
+
| number
−
| Folder whose content to list.
+
| Unique ID of profile.
 
|}
 
|}
  
−
== GetProfiles ==
+
== DeleteUser ==
−
Get list of archiving and exporting profiles.
+
Delete a MailStore user.
  
 
=== Arguments ===
 
=== Arguments ===
Line 1,440: Line 1,781:
 
| Unique ID of MailStore instance in which this command is invoked.
 
| Unique ID of MailStore instance in which this command is invoked.
 
|-
 
|-
−
| <tt>raw</tt>
+
| <tt>userName</tt>
−
| bool
+
| string
−
| Currently only 'true' is supported.
+
| User name of MailStore user.
 
|}
 
|}
  
−
== GetTimeZones ==
+
== DisableMFA ==
−
Get list of available time zones.
+
Disables multi-factor authentication of a user.
  
 
=== Arguments ===
 
=== Arguments ===
Line 1,457: Line 1,798:
 
| string  
 
| string  
 
| Unique ID of MailStore instance in which this command is invoked.
 
| Unique ID of MailStore instance in which this command is invoked.
 +
|-
 +
| <tt>userName</tt>
 +
| string
 +
| The user name of the user for whom MFA shall be disabled.
 
|}
 
|}
  
−
== GetUserInfo ==
+
[[Management_API_-_Function_Reference#InitializeMFA|InitializeMFA]] enables multi-factor authentication of a user.
−
Get detailed information about user.
+
 
 +
== GetChildFolders ==
 +
Get child folders.
  
 
=== Arguments ===
 
=== Arguments ===
Line 1,472: Line 1,819:
 
| Unique ID of MailStore instance in which this command is invoked.
 
| Unique ID of MailStore instance in which this command is invoked.
 
|-
 
|-
−
| <tt>userName</tt>
+
| <tt>folder</tt>
−
| string  
+
| string (optional)
−
| User name of MailStore user
+
| Parent folder.
 +
|-
 +
| <tt>maxLevels</tt>
 +
| number (optional)
 +
| Depth of child folders.
 
|}
 
|}
  
−
== GetUsers ==
+
== GetComplianceConfiguration ==
−
Get list of users.
+
Get current compliance configuration settings.
  
 
=== Arguments ===
 
=== Arguments ===
Line 1,491: Line 1,842:
 
|}
 
|}
  
−
== GetWorkerResults ==
+
== GetCredentials ==
−
Get results of profile executions.
+
Get the list of credential objects and their details.
  
 
=== Arguments ===
 
=== Arguments ===
Line 1,503: Line 1,854:
 
| string  
 
| string  
 
| Unique ID of MailStore instance in which this command is invoked.
 
| Unique ID of MailStore instance in which this command is invoked.
 +
|}
 +
 +
== GetDirectoryServicesConfiguration ==
 +
Get current Directory Services configuration settings.
 +
 +
=== Arguments ===
 +
{| class="wikitable"
 +
! width=150px | Name
 +
! width=120px | Type
 +
! Description
 
|-
 
|-
−
| <tt>fromIncluding</tt>
+
| <tt>instanceID</tt>
 
| string  
 
| string  
−
| Beginning of time range to fetch.
+
| Unique ID of MailStore instance in which this command is invoked.
−
|-
+
|}
−
| <tt>toExcluding</tt>
+
 
−
| string
+
== GetFolderStatistics ==
−
| End of time range to fetch.
+
Get folder statistics.
−
|-
 
−
| <tt>timeZoneID</tt>
 
−
| string
 
−
| Time zone in which timestamp should be returned.
 
−
|-
 
−
| <tt>profileID</tt>
 
−
| number (optional)
 
−
| Filter results by given profile ID.
 
−
|-
 
−
| <tt>userName</tt>
 
−
| string (optional)
 
−
| Filter results by given user name.
 
−
|}
 
−
 
 
−
== MoveFolder ==
 
−
Move folder.
 
  
 
=== Arguments ===
 
=== Arguments ===
Line 1,537: Line 1,882:
 
| string  
 
| string  
 
| Unique ID of MailStore instance in which this command is invoked.
 
| Unique ID of MailStore instance in which this command is invoked.
−
|-
 
−
| <tt>fromFolder</tt>
 
−
| string
 
−
| Old folder name.
 
−
|-
 
−
| <tt>toFolder</tt>
 
−
| string
 
−
| New folder name.
 
 
|}
 
|}
  
−
== RenameUser ==
+
== GetJobResults ==
−
Rename a MailStore user.
+
Retrieves list of finished job executions.
  
 
=== Arguments ===
 
=== Arguments ===
Line 1,560: Line 1,897:
 
| Unique ID of MailStore instance in which this command is invoked.
 
| Unique ID of MailStore instance in which this command is invoked.
 
|-
 
|-
−
| <tt>oldUserName</tt>
+
| <tt>fromIncluding</tt>
 
| string  
 
| string  
−
| Old user name.
+
| Beginning of time range to fetch.
 +
|-
 +
| <tt>toExcluding</tt>
 +
| string
 +
| End of time range to fetch.
 
|-
 
|-
−
| <tt>newUserName</tt>
+
| <tt>timeZoneId</tt>
 
| string  
 
| string  
−
| New user name.
+
| 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.
 
|}
 
|}
  
−
== RunProfile ==
+
Interactive Management Shell Example: ''GetJobResults --fromIncluding="2022-12-01T00:00:00" --toExcluding="2023-01-01T00:00:00" --timeZoneId="$Local" --jobId=1''
−
Run an existing archiving or exporting profile.
+
 
 +
Use the API command [[Management_API_-_Function_Reference#GetTimeZones|GetTimeZones]] to retrieve a list of all available time zones.
 +
 
 +
== GetJobs ==
 +
Retrieve list of jobs
  
 
=== Arguments ===
 
=== Arguments ===
Line 1,581: Line 1,930:
 
| string  
 
| string  
 
| Unique ID of MailStore instance in which this command is invoked.
 
| Unique ID of MailStore instance in which this command is invoked.
−
|-
 
−
| <tt>id</tt>
 
−
| number
 
−
| Unique profile ID.
 
 
|}
 
|}
  
−
== RunTemporaryProfile ==
+
== GetProfiles ==
−
Run a temporary/non-existent profile.
+
Get list of archiving and exporting profiles.
  
 
=== Arguments ===
 
=== Arguments ===
Line 1,599: Line 1,944:
 
| string  
 
| string  
 
| Unique ID of MailStore instance in which this command is invoked.
 
| Unique ID of MailStore instance in which this command is invoked.
−
|-
 
−
| <tt>properties</tt>
 
−
| json
 
−
| Profile properties.
 
 
|-
 
|-
 
| <tt>raw</tt>
 
| <tt>raw</tt>
Line 1,609: Line 1,950:
 
|}
 
|}
  
−
=== Argument Values ===
+
== GetSmtpSettings ==
−
 
+
Get current SMTP configuration.
−
== SetComplianceConfiguration ==
 
−
Set compliance configuration settings.
 
  
 
=== Arguments ===
 
=== Arguments ===
Line 1,623: Line 1,962:
 
| string  
 
| string  
 
| Unique ID of MailStore instance in which this command is invoked.
 
| Unique ID of MailStore instance in which this command is invoked.
−
|-
+
|}
−
| <tt>config</tt>
+
 
−
| json
+
== GetTimeZones ==
−
| Compliance configuration.
+
Get the list of available time zones and their IDs.
−
|}
 
−
 
 
−
=== Argument Values ===
 
  
−
==== config ====
+
The ''id'' of the output can be used as ''timeZoneId'' in [[Management_API_-_Function_Reference#CreateJob|CreateJob]], [[Management_API_-_Function_Reference#GetJobResults|GetJobResults]], [[Management_API_-_Function_Reference#SetJobSchedule|SetJobSchedule]] and [[Management_API_-_Function_Reference#SendStatusReport|SendStatusReport]] and as ''timeZoneID'' (with a capital ''ID'') in [[Management_API_-_Function_Reference#GetWorkerResults|GetWorkerResults]].
−
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
 
−
UseGetComplianceConfigurationtoreceivesupportedvalue.
 
−
</source>
 
  
−
== SetDirectoryServicesConfiguration ==
 
−
Set directory services configuration settings.
 
  
 
=== Arguments ===
 
=== Arguments ===
Line 1,648: Line 1,979:
 
| string  
 
| string  
 
| Unique ID of MailStore instance in which this command is invoked.
 
| Unique ID of MailStore instance in which this command is invoked.
−
|-
 
−
| <tt>config</tt>
 
−
| json
 
−
| Directory services configuration.
 
 
|}
 
|}
  
−
=== Argument Values ===
+
== GetUserInfo ==
−
 
+
Get detailed information about user.
−
==== config ====
 
−
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
 
−
UseGetDirectoryServicesConfigurationtoreceivesupportedvalue.
 
−
</source>
 
−
 
 
−
== SetUserAuthentication ==
 
−
Set authentication settings of a MailStore user.
 
  
 
=== Arguments ===
 
=== Arguments ===
Line 1,676: Line 1,996:
 
| <tt>userName</tt>
 
| <tt>userName</tt>
 
| string  
 
| string  
−
| User name of MailStore user.
+
| User name of MailStore user
−
|-
 
−
| <tt>authentication</tt>
 
−
| string
 
−
| Authentication method. Either 'Standard' or 'Windows Authentication'.
 
 
|}
 
|}
  
−
== SetUserDistinguishedName ==
+
== GetUsers ==
−
Set the LDAP distinguished name of a MailStore user.
+
Get list of users.
  
 
=== Arguments ===
 
=== Arguments ===
Line 1,695: Line 2,011:
 
| string  
 
| string  
 
| Unique ID of MailStore instance in which this command is invoked.
 
| Unique ID of MailStore instance in which this command is invoked.
−
|-
 
−
| <tt>userName</tt>
 
−
| string
 
−
| User name of MailStore user.
 
−
|-
 
−
| <tt>distinguishedName</tt>
 
−
| string (optional)
 
−
| LDAP DN string.
 
 
|}
 
|}
  
−
== SetUserEmailAddresses ==
+
== GetWorkerResults ==
−
Set email addresses of MailStore user.
+
Get results of profile executions.
  
 
=== Arguments ===
 
=== Arguments ===
Line 1,718: Line 2,026:
 
| Unique ID of MailStore instance in which this command is invoked.
 
| Unique ID of MailStore instance in which this command is invoked.
 
|-
 
|-
−
| <tt>userName</tt>
+
| <tt>fromIncluding</tt>
 +
| string
 +
| Beginning of time range to fetch.
 +
|-
 +
| <tt>toExcluding</tt>
 
| string  
 
| string  
−
| User name of MailStore user.
+
| End of time range to fetch.
 
|-
 
|-
−
| <tt>emailAddresses</tt>
+
| <tt>timeZoneID</tt>
−
| string (optional)
+
| string  
−
| List of email addresses.
+
| 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>
−
== SetUserFullName ==
+
| number (optional)
−
Set full name of MailStore user.
+
| Filter results by given profile ID.
 +
|-
 +
| <tt>userName</tt>
 +
| string (optional)
 +
| If given, must be equal to the current username. Filters results by current user.
 +
|}
 +
 
 +
Interactive Management Shell Example: ''GetWorkerResults --fromIncluding="2022-01-01T00:00:00" --toExcluding="2023-01-01T00:00:00" --timeZoneID="$Local" --profileID=1 --userName="admin"''
 +
 
 +
Use the API command [[Management_API_-_Function_Reference#GetTimeZones|GetTimeZones]] to retrieve a list of all available time zones and their ids.
 +
 
 +
Be aware that ''timeZoneID'' has to be written with a capital ''ID'' where all other commands with a ''timeZoneId'' are expecting ''Id''.
 +
 
 +
== GetWorkerResultReport ==
 +
Get the details of a profile execution result.
  
 
=== Arguments ===
 
=== Arguments ===
Line 1,740: Line 2,066:
 
| Unique ID of MailStore instance in which this command is invoked.
 
| Unique ID of MailStore instance in which this command is invoked.
 
|-
 
|-
−
| <tt>userName</tt>
+
| <tt>id</tt>
−
| string
+
| number
−
| User name of MailStore user.
+
| The ID of the result for which the details should be fetched.
−
|-
 
−
| <tt>fullName</tt>
 
−
| string (optional)
 
−
| Full name of MailStore user.
 
 
|}
 
|}
  
−
== SetUserPassword ==
+
Use the [[Management_API_-_Function_Reference#GetWorkerResults|GetWorkerResults]] command to get the IDs of results.
−
Set password of MailStore user.
+
 
 +
== InitializeMFA ==
 +
Initializes multi-factor authentication of a user. The user has to scan a QR code with a TOTP compatible app and has to enter an MFA code to be able to login.
 +
When ''InitializeMFA'' is called when MFA is already active for a user, a new secret is generated and the user has to scan the QR code again. This also invalidates all trusted device tokens of a user.
  
 
=== Arguments ===
 
=== Arguments ===
Line 1,764: Line 2,089:
 
| <tt>userName</tt>
 
| <tt>userName</tt>
 
| string  
 
| string  
−
| User name of MailStore user.
+
| The user name of the user for whom MFA shall be initialized.
−
|-
 
−
| <tt>password</tt>
 
−
| string
 
−
| Password of MailStore user.
 
 
|}
 
|}
  
−
== SetUserPop3UserNames ==
+
[[Management_API_-_Function_Reference#DisableMFA|DisableMFA]] disables multi-factor authentication of a user.
−
Set POP3 user name of MailStore user.
+
 
 +
== MoveFolder ==
 +
Move folder.
  
 
=== Arguments ===
 
=== Arguments ===
Line 1,784: Line 2,107:
 
| Unique ID of MailStore instance in which this command is invoked.
 
| Unique ID of MailStore instance in which this command is invoked.
 
|-
 
|-
−
| <tt>userName</tt>
+
| <tt>fromFolder</tt>
 
| string  
 
| string  
−
| User name of MailStore user.
+
| Old folder name.
 
|-
 
|-
−
| <tt>pop3UserNames</tt>
+
| <tt>toFolder</tt>
−
| string (optional)
+
| string  
−
| Comma seperated list of POP3 user names.
+
| New folder name.
 
|}
 
|}
  
−
== SetUserPrivileges ==
+
== RenameJob ==
−
Set privileges of MailStore user.
+
Rename job.
  
 
=== Arguments ===
 
=== Arguments ===
Line 1,806: Line 2,129:
 
| Unique ID of MailStore instance in which this command is invoked.
 
| Unique ID of MailStore instance in which this command is invoked.
 
|-
 
|-
−
| <tt>userName</tt>
+
| <tt>id</tt>
−
| string
+
| number (optional)
−
| User name of MailStore user.
+
| The unique identifier of the job to be renamed.
 
|-
 
|-
−
| <tt>privileges</tt>
+
| <tt>name</tt>
−
| string  
+
| string (optional)
−
| Comma separated list of privileges.
+
| The new job name.
 
|}
 
|}
−
 
+
 
−
== SetUserPrivilegesOnFolder ==
+
== RenameUser ==
−
Set privileges on folder for MailStore user.
+
Rename a MailStore user.
−
 
+
 
−
=== Arguments ===
+
=== Arguments ===
−
{| class="wikitable"
+
{| class="wikitable"
−
! width=150px | Name
+
! width=150px | Name
−
! width=120px | Type
+
! width=120px | Type
−
! Description
+
! Description
−
|-
+
|-
−
| <tt>instanceID</tt>
+
| <tt>instanceID</tt>
−
| string  
+
| string
−
| Unique ID of MailStore instance in which this command is invoked.
+
| Unique ID of MailStore instance in which this command is invoked.
−
|-
+
|-
−
| <tt>userName</tt>
+
| <tt>oldUserName</tt>
−
| string  
+
| string
−
| User name of MailStore user.
+
| Old user name.
−
|-
+
|-
−
| <tt>folder</tt>
+
| <tt>newUserName</tt>
−
| string  
+
| string
−
| Folder name.
+
| New user name.
−
|-
+
|}
−
| <tt>privileges</tt>
+
 
−
| string  
+
== RunJobAsync ==
−
| Comma separated list of folder privileges.
+
Run an existing job.
 +
 
 +
=== Arguments ===
 +
{| class="wikitable"
 +
! width=150px | Name
 +
! width=120px | Type
 +
! Description
 +
|-
 +
| <tt>instanceID</tt>
 +
| string
 +
| Unique ID of MailStore instance in which this command is invoked.
 +
|-
 +
| <tt>id</tt>
 +
| number
 +
| The identifier of the job to be run.
 +
|}
 +
 
 +
== RunProfile ==
 +
Run an existing archiving or exporting profile. Only profiles that are executed on server side can be started by this command. That are all profiles which are listed under ''E-Mail Servers'' in the E-Mail-Archive Client. Client side profiles can be started by using the ''MailStoreCmd'' and the commands ''import-execute'' and ''export-execute''.
 +
 
 +
=== Arguments ===
 +
{| class="wikitable"
 +
! width=150px | Name
 +
! width=120px | Type
 +
! Description
 +
|-
 +
| <tt>instanceID</tt>
 +
| string
 +
| Unique ID of MailStore instance in which this command is invoked.
 +
|-
 +
| <tt>id</tt>
 +
| number
 +
| Unique profile ID.
 +
|}
 +
 
 +
== RunTemporaryProfile ==
 +
Run a temporary/non-existent profile. Only profiles that are executed on server side can be started by this command. That are all profiles which are listed under ''E-Mail Servers'' in the E-Mail-Archive Client.
 +
 
 +
=== Arguments ===
 +
{| class="wikitable"
 +
! width=150px | Name
 +
! width=120px | Type
 +
! Description
 +
|-
 +
| <tt>instanceID</tt>
 +
| string
 +
| Unique ID of MailStore instance in which this command is invoked.
 +
|-
 +
| <tt>properties</tt>
 +
| json
 +
| Profile properties.
 +
|-
 +
| <tt>raw</tt>
 +
| bool
 +
| Currently only 'true' is supported.
 +
|}
 +
 
 +
=== Argument Values ===
 +
 
 +
==== properties ====
 +
To receive available profile properties create a profile of the desired type via MailStore Client and use the GetProfiles method to receive supported value. ''Id'' and ''Version'' attributes must not be set.
 +
 
 +
== SendStatusReport ==
 +
Send a status report to the given recipients.
 +
 
 +
=== Arguments ===
 +
{| class="wikitable"
 +
! width=150px | Name
 +
! width=120px | Type
 +
! Description
 +
|-
 +
| <tt>instanceID</tt>
 +
| string
 +
| Unique ID of MailStore instance in which this command is invoked.
 +
|-
 +
| <tt>timespan</tt>
 +
| string
 +
| Timespan that is covered by the status report.
 +
|-
 +
| <tt>timeZoneId</tt>
 +
| string
 +
| The id of the time zone the date should be converted to, e.g. $Local, which represents the time zone of the operating system.
 +
|-
 +
| <tt>recipients</tt>
 +
| string
 +
| Comma separated list of recipients that will receive the status report.
 +
|}
 +
 
 +
Use the API command [[Management_API_-_Function_Reference#GetTimeZones|GetTimeZones]] to retrieve a list of all available time zones and their ids.
 +
=== Argument Values ===
 +
 
 +
==== Timespan ====
 +
{| class="wikitable"
 +
! width=270px | Name
 +
! Description
 +
|-
 +
| <tt>today</tt>
 +
| The day when the status report is sent.
 +
|-
 +
| <tt>yesterday</tt>
 +
| The day before the status report is sent.
 +
|-
 +
| <tt>thisweek</tt>
 +
| The week when the status report is sent.
 +
|-
 +
| <tt>lastweek</tt>
 +
| The week before the status report is sent.
 +
|-
 +
| <tt>thismonth</tt>
 +
| The month when the status report is sent.
 +
|-
 +
| <tt>lastmonth</tt>
 +
| The month before the status report is sent.
 +
|}
 +
 
 +
 
 +
== SetComplianceConfiguration ==
 +
Set compliance configuration settings.
 +
 
 +
=== Arguments ===
 +
{| class="wikitable"
 +
! width=150px | Name
 +
! width=120px | Type
 +
! Description
 +
|-
 +
| <tt>instanceID</tt>
 +
| string
 +
| Unique ID of MailStore instance in which this command is invoked.
 +
|-
 +
| <tt>config</tt>
 +
| json
 +
| Compliance configuration.
 +
|}
 +
 
 +
=== Argument Values ===
 +
 
 +
==== config ====
 +
Use GetComplianceConfiguration to receive supported value.
 +
 
 +
Example settings object:
 +
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
 +
{
 +
  "adminEmailPreviewEnabled": true,
 +
  "legalHoldEnabled": false,
 +
  "logSuccessfulUserActivities": [
 +
    "AdminRestored",
 +
    "ComplianceChangeSettings",
 +
    "FileGroupAttach",
 +
    "FileGroupCreate",
 +
    "FileGroupDetach",
 +
    "FileGroupRename",
 +
    "FileGroupSetProperties",
 +
    "FileGroupSetRequestedState",
 +
    "ProfileChangeUserName",
 +
    "UserAdd",
 +
    "UserDelete",
 +
    "UserRename",
 +
    "UserSetFolderAccess",
 +
    "UserSetMappings",
 +
    "UserUpdate"
 +
  ]
 +
}
 +
</source>
 +
 
 +
== SetDirectoryServicesConfiguration ==
 +
Set directory services configuration settings.
 +
 
 +
=== Arguments ===
 +
{| class="wikitable"
 +
! width=150px | Name
 +
! width=120px | Type
 +
! Description
 +
|-
 +
| <tt>instanceID</tt>
 +
| string
 +
| Unique ID of MailStore instance in which this command is invoked.
 +
|-
 +
| <tt>config</tt>
 +
| json
 +
| Directory services configuration.
 +
|}
 +
 
 +
=== Argument Values ===
 +
 
 +
==== config ====
 +
Use GetDirectoryServicesConfiguration to receive supported value.
 +
 
 +
== SetJobEnabled ==
 +
Set enabled status of a job.
 +
 
 +
=== Arguments ===
 +
{| class="wikitable"
 +
! width=150px | Name
 +
! width=120px | Type
 +
! Description
 +
|-
 +
| <tt>instanceID</tt>
 +
| string
 +
| Unique ID of MailStore instance in which this command is invoked.
 +
|-
 +
| <tt>id</tt>
 +
| number (optional)
 +
| The unique identifier of the job to be modified.
 +
|-
 +
| <tt>enabled</tt>
 +
| bool (optional)
 +
| Boolean value of '''enabled''' attribute.
 +
|}
 +
 
 +
== SetJobSchedule ==
 +
Modify the schedule of a job.
 +
 
 +
=== Arguments ===
 +
{| class="wikitable"
 +
! width=150px | Name
 +
! width=120px | Type
 +
! Description
 +
|-
 +
| <tt>id</tt>
 +
| number
 +
| The unique identifier of the job to be modified.
 +
|-
 +
| <tt>timeZoneId</tt>
 +
| string
 +
| The time zone id of the time zone the date should be converted to, e.g. $Local, which represents the time zone of the operating system.
 +
|-
 +
| <tt>date</tt>
 +
| string (optional)
 +
| Datetime string (YYYY-MM-DDThh:mm:ss) for running the job once.
 +
|-
 +
| <tt>interval</tt>
 +
| number (optional)
 +
| Interval for running job.
 +
|-
 +
| <tt>time</tt>
 +
| string (optional)
 +
| Time for running job. Without additional parameter, this means daily execution.
 +
|-
 +
| <tt>dayOfWeek</tt>
 +
| string (optional)
 +
| Day of week to run job. Parameter "time" also required.
 +
|-
 +
| <tt>dayOfMonth</tt>
 +
| string (optional)
 +
| Day of month to run job. Parameter "time" also required. dayOfWeek can optionally be used to define further.
 +
|}
 +
 
 +
Use the API command [[Management_API_-_Function_Reference#GetTimeZones|GetTimeZones]] to retrieve a list of all available time zones.
 +
=== Argument Values ===
 +
 
 +
==== interval ====
 +
{| class="wikitable"
 +
! width=270px | Name
 +
! Description
 +
|-
 +
| <tt>5</tt>
 +
| Every 5 minutes.
 +
|-
 +
| <tt>10</tt>
 +
| Every 10 minutes.
 +
|-
 +
| <tt>15</tt>
 +
| Every 15 minutes.
 +
|-
 +
| <tt>20</tt>
 +
| Every 20 minutes.
 +
|-
 +
| <tt>30</tt>
 +
| Every 30 minutes.
 +
|-
 +
| <tt>60</tt>
 +
| Every hour.
 +
|-
 +
| <tt>120</tt>
 +
| Every 2 hours.
 +
|-
 +
| <tt>180</tt>
 +
| Every 3 hours.
 +
|-
 +
| <tt>260</tt>
 +
| Every 4 hours.
 +
|-
 +
| <tt>360</tt>
 +
| Every 6 hours.
 +
|-
 +
| <tt>720</tt>
 +
| Every 12 hours.
 +
|}
 +
 
 +
==== dayOfWeek ====
 +
{| class="wikitable"
 +
! width=270px | Name
 +
! Description
 +
|-
 +
| <tt>Sunday</tt>
 +
| Sunday
 +
|-
 +
| <tt>Monday</tt>
 +
| Monday
 +
|-
 +
| <tt>Tuesday</tt>
 +
| Tuesday
 +
|-
 +
| <tt>Wednesday</tt>
 +
| Wednesday
 +
|-
 +
| <tt>Thursday</tt>
 +
| Thursday
 +
|-
 +
| <tt>Friday</tt>
 +
| Friday
 +
|-
 +
| <tt>Saturday</tt>
 +
| Saturday
 +
|}
 +
 
 +
==== dayOfMonth ====
 +
{| class="wikitable"
 +
! width=270px | Name
 +
! Description
 +
|-
 +
| <tt>1 to 31</tt>
 +
| Numeric representation of day of month.
 +
|-
 +
| <tt>Last</tt>
 +
| Last day of month.
 +
|}
 +
 
 +
== SetProfileServerSideExecution ==
 +
Disables or enables the automatic server-sided execution with its parameters.
 +
 
 +
=== Arguments ===
 +
{| class="wikitable"
 +
! width=150px | Name
 +
! width=120px | Type
 +
! Description
 +
|-
 +
| <tt>instanceID</tt>
 +
| string
 +
| Unique ID of MailStore instance in which this command is invoked.
 +
|-
 +
| <tt>id</tt>
 +
| number
 +
| The unique profile ID of the profile to be modified.
 +
|-
 +
| <tt>automatic</tt>
 +
| bool
 +
| Enables (true) or disables (false) the profile's server-side automation.
 +
|-
 +
| <tt>automaticPauseBetweenExecutions</tt>
 +
| number (optional)
 +
| Integer value (0 - 2147483647) of seconds to pause between re-executing an automatic profile.
 +
|-
 +
| <tt>automaticMaintenanceWindows</tt>
 +
| string (optional)
 +
| TimeSpan string (hh:mm-hh:mm, e.g. 22:00-04:00) for the time window where the execution should not be executed, e.g. to schedule maintenance tasks.
 +
|}
 +
 
 +
Use the API command [[Management_API_-_Function_Reference#GetProfiles|GetProfiles]] to retrieve a list of all profiles and their current "serverSideExecution" section details.
 +
 
 +
The command can be executed with either the argument ''automatic=false'' and no additional parameters to disable the automation, or with ''automatic=true'' and at least the ''automaticPauseBetweenExecutions'' value given. The ''automaticMaintenanceWindows'' parameter is optional. Setting an already automated profile to automatic again, will restart the profile.
 +
 
 +
== SetSmtpSettings ==
 +
Set SMTP configuration.
 +
 
 +
=== Arguments ===
 +
{| class="wikitable"
 +
! width=150px | Name
 +
! width=120px | Type
 +
! Description
 +
|-
 +
| <tt>instanceID</tt>
 +
| string
 +
| Unique ID of MailStore instance in which this command is invoked.
 +
|-
 +
| <tt>settings</tt>
 +
| json
 +
| SMTP configuration.
 +
|}
 +
 
 +
=== Argument Values ===
 +
 
 +
==== settings====
 +
Example settings object:
 +
<source lang="js" smart-tabs="true" toolbar="false" gutter="false">
 +
{
 +
  "hostname": "mail.example.com",
 +
  "port": 587,
 +
  "protocol": "SMTP-TLS",
 +
  "ignoreSslPolicyErrors": false,
 +
  "authenticationRequired": true,
 +
  "username": "[email protected]",
 +
  "password": "userpassword",
 +
  "fromDisplayName": "Sending User",
 +
  "fromEmailAddress": "[email protected]",
 +
  "recipientEmailAddresses": ["[email protected]", "[email protected]"]
 +
}
 +
</source>
 +
 
 +
== SetUserAuthentication ==
 +
Set authentication settings of a MailStore user.
 +
 
 +
=== Arguments ===
 +
{| class="wikitable"
 +
! width=150px | Name
 +
! width=120px | Type
 +
! Description
 +
|-
 +
| <tt>instanceID</tt>
 +
| string
 +
| Unique ID of MailStore instance in which this command is invoked.
 +
|-
 +
| <tt>userName</tt>
 +
| string
 +
| User name of MailStore user.
 +
|-
 +
| <tt>authentication</tt>
 +
| string
 +
| Authentication method. Either 'integrated' or 'directoryServices'.
 +
|}
 +
 
 +
== SetUserDistinguishedName ==
 +
Set the LDAP distinguished name of a MailStore user.
 +
 
 +
=== Arguments ===
 +
{| class="wikitable"
 +
! width=150px | Name
 +
! width=120px | Type
 +
! Description
 +
|-
 +
| <tt>instanceID</tt>
 +
| string
 +
| Unique ID of MailStore instance in which this command is invoked.
 +
|-
 +
| <tt>userName</tt>
 +
| string
 +
| User name of MailStore user.
 +
|-
 +
| <tt>distinguishedName</tt>
 +
| string (optional)
 +
| LDAP DN string.
 +
|}
 +
 
 +
== SetUserEmailAddresses ==
 +
Set email addresses of MailStore user.
 +
 
 +
=== Arguments ===
 +
{| class="wikitable"
 +
! width=150px | Name
 +
! width=120px | Type
 +
! Description
 +
|-
 +
| <tt>instanceID</tt>
 +
| string
 +
| Unique ID of MailStore instance in which this command is invoked.
 +
|-
 +
| <tt>userName</tt>
 +
| string
 +
| User name of MailStore user.
 +
|-
 +
| <tt>emailAddresses</tt>
 +
| string (optional)
 +
| List of email addresses.
 +
|}
 +
 
 +
== SetUserFullName ==
 +
Set full name of MailStore user.
 +
 
 +
=== Arguments ===
 +
{| class="wikitable"
 +
! width=150px | Name
 +
! width=120px | Type
 +
! Description
 +
|-
 +
| <tt>instanceID</tt>
 +
| string
 +
| Unique ID of MailStore instance in which this command is invoked.
 +
|-
 +
| <tt>userName</tt>
 +
| string
 +
| User name of MailStore user.
 +
|-
 +
| <tt>fullName</tt>
 +
| string (optional)
 +
| Full name of MailStore user.
 +
|}
 +
 
 +
== SetUserLoginPrivileges ==
 +
Set login privileges of a MailStore user.
 +
 
 +
=== Arguments ===
 +
{| class="wikitable"
 +
! width=150px | Name
 +
! width=120px | Type
 +
! Description
 +
|-
 +
| <tt>instanceID</tt>
 +
| string
 +
| Unique ID of MailStore instance in which this command is invoked.
 +
|-
 +
| <tt>userName</tt>
 +
| string
 +
| User name of MailStore user.
 +
|-
 +
| <tt>loginPrivileges</tt>
 +
| string
 +
| Comma separated list of login privileges.
 +
|}
 +
 
 +
=== Argument Values ===
 +
 
 +
==== loginPrivileges ====
 +
{{Management_API_User_Login_Privileges}}
 +
 
 +
== SetUserPassword ==
 +
Set password of MailStore user.
 +
 
 +
=== Arguments ===
 +
{| class="wikitable"
 +
! width=150px | Name
 +
! width=120px | Type
 +
! Description
 +
|-
 +
| <tt>instanceID</tt>
 +
| string
 +
| Unique ID of MailStore instance in which this command is invoked.
 +
|-
 +
| <tt>userName</tt>
 +
| string
 +
| User name of MailStore user.
 +
|-
 +
| <tt>password</tt>
 +
| string
 +
| Password of MailStore user.
 +
|}
 +
 
 +
== SetUserPop3UserNames ==
 +
Set POP3 user name of MailStore user.
 +
 
 +
=== Arguments ===
 +
{| class="wikitable"
 +
! width=150px | Name
 +
! width=120px | Type
 +
! Description
 +
|-
 +
| <tt>instanceID</tt>
 +
| string
 +
| Unique ID of MailStore instance in which this command is invoked.
 +
|-
 +
| <tt>userName</tt>
 +
| string
 +
| User name of MailStore user.
 +
|-
 +
| <tt>pop3UserNames</tt>
 +
| string (optional)
 +
| Comma separated list of POP3 user names.
 +
|}
 +
 
 +
== SetUserPrivileges ==
 +
Set privileges of MailStore user.
 +
 
 +
=== Arguments ===
 +
{| class="wikitable"
 +
! width=150px | Name
 +
! width=120px | Type
 +
! Description
 +
|-
 +
| <tt>instanceID</tt>
 +
| string
 +
| Unique ID of MailStore instance in which this command is invoked.
 +
|-
 +
| <tt>userName</tt>
 +
| string
 +
| User name of MailStore user.
 +
|-
 +
| <tt>privileges</tt>
 +
| string
 +
| Comma separated list of privileges.
 +
|}
 +
 
 +
=== Argument Values ===
 +
 
 +
==== privileges ====
 +
{{Template:Management_API_User_Privileges}}
 +
 
 +
== SetUserPrivilegesOnFolder ==
 +
Set privileges on folder for MailStore user.
 +
 
 +
=== Arguments ===
 +
{| class="wikitable"
 +
! width=150px | Name
 +
! width=120px | Type
 +
! Description
 +
|-
 +
| <tt>instanceID</tt>
 +
| string  
 +
| Unique ID of MailStore instance in which this command is invoked.
 +
|-
 +
| <tt>userName</tt>
 +
| string  
 +
| User name of MailStore user.
 +
|-
 +
| <tt>folder</tt>
 +
| string  
 +
| Folder name.
 +
|-
 +
| <tt>privileges</tt>
 +
| string  
 +
| Comma separated list of folder privileges.
 +
|}
 +
 
 +
=== Argument Values ===
 +
 
 +
==== privileges ====
 +
 
 +
{| class="wikitable"
 +
! width=270px | Name
 +
! Description
 +
|-
 +
| <tt>none</tt>
 +
| The user is denied access to the specified folder. If specified, this value has to be the only value in the list. This effectively removes all privileges on the specified folder.
 +
|-
 +
| <tt>read</tt>
 +
| The user is granted read access to the specified folder.
 +
|-
 +
| <tt>write</tt>
 +
| The user is granted write access to the specified folder. Messages can be moved within an archive.
 +
|-
 +
| <tt>delete</tt>
 +
| The user is granted delete access to the specified folder.
 +
|}
 +
 
 +
== SyncUsersWithDirectoryServices ==
 +
Sync users of MailStore instance with directory services.
 +
 
 +
=== Arguments ===
 +
{| class="wikitable"
 +
! width=150px | Name
 +
! width=120px | Type
 +
! Description
 +
|-
 +
| <tt>instanceID</tt>
 +
| string
 +
| Unique ID of MailStore instance in which this command is invoked.
 +
|-
 +
| <tt>dryRun</tt>
 +
| bool (optional)
 +
| Simulate sync only.
 
|}
 
|}
  
−
== SyncUsersWithDirectoryServices ==
+
== TestSmtpSettings ==
−
Sync users of MailStore instance with directory services.
+
Test current SMTP configuration.
  
 
=== Arguments ===
 
=== Arguments ===
Line 1,853: Line 2,823:
 
| string  
 
| string  
 
| Unique ID of MailStore instance in which this command is invoked.
 
| Unique ID of MailStore instance in which this command is invoked.
−
|-
 
−
| <tt>dryRun</tt>
 
−
| bool (optional)
 
−
| Simulate sync only.
 
 
|}
 
|}

Latest revision as of 11:41, 8 April 2024


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.
databasePath string Path of the directory containing the archive store database. When it is the only given path argument, the values for contentPath and indexPath are determined automatically.
contentPath string (optional) Path of directory containing archive store content.
indexPath string (optional) Path of directory containing archive store index files.
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,
  "imapServerConnectionLogEnabled" : bool,
  "vssWriterEnabled" : bool,
  "vssWriterExcludeIndexes" : bool,
}

Config Arguments

Name Type Description
instanceID string Possible characters are a-z, 0-9 and a dash (-). Only lower-case letters are allowed. The first character has to be a letter. The minimum length is 3 characters, the maximum length is 32 characters.
startMode string Possible values are automatic, manual, and disabled. Automatic instances are started automatically with the Instance Host. Manual instances must be started manually. Disabled instances cannot be started at all.

CreateInstanceHost

Create a new Instance Host.

Arguments

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.
databasePath string Path of the directory containing the archive store database. When it is the only given path argument, the values for contentPath and indexPath are determined automatically.
contentPath string (optional) Path of directory containing archive store content.
indexPath string (optional) Path of directory containing archive store index files.
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
}

CreateSystemAdministratorAPIPassword

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

DeactivateSystemAdministratorMFA

Deactivates Multi-Factor Authentication for SPE system administrator.

Arguments

Name Type Description
userName string User name of 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 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.
includeSize bool (optional) Includes size of archive store. Default: true. May be slow when running on slow hardware.

GetSystemAdministrators

Get list of system administrators. The list contains the name, the full name, the email address and the Multi-Factor Authentication status.

InitializeSystemAdministratorMFA

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

Arguments

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

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

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

RecreateRecoveryRecords

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

{
  "sizeThreshold" : string or null,
  "baseDirectory" : string,
  "contentBaseDirectory" : string,
  "indexBaseDirectory" : 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.
databasePath string Path of the directory containing the archive store database. When it is the only given path argument, the values for contentPath and indexPath are determined automatically.
contentPath string (optional) Path of directory containing archive store content.
indexPath string (optional) Path of directory containing archive store index files.

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

UpgradeStores

Upgrade all archive stores from an older version to the current format.

Arguments

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

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

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

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 SetUserPrivilegesOnFolder 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.
loginPrivileges string (optional) Comma separated list of log in privileges. If not given, all login privileges are assigned.

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.

loginPrivileges

Name Description
none The user is granted no login privileges. If specified, this value has to be the only value in the list.
windows The user is allowed to use the Windows Client.
web The user is allowed to use the Web Access.
outlook The user is allowed to use the Outlook Add-in.
windowsCmd The user is allowed to use scheduled tasks and the command line client of MailStore Client.
imap The user is allowed to access the archive using IMAP.

DeleteAppPasswords

Deletes all app passwords of a user, hence all non-interactive logins will fail and have to be reconfigured by the user.

Arguments

Name Type Description
instanceID string Unique ID of MailStore instance in which this command is invoked.
userName string The user name of the user whose app passwords shall be deleted.

DeleteEmptyFolders

Remove folders from folder tree that do not contain emails.

Arguments

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.

DisableMFA

Disables multi-factor authentication of a user.

Arguments

Name Type Description
instanceID string Unique ID of MailStore instance in which this command is invoked.
userName string The user name of the user for whom MFA shall be disabled.

InitializeMFA enables multi-factor authentication of a 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.

GetCredentials

Get the list of credential objects and their details.

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="2022-12-01T00:00:00" --toExcluding="2023-01-01T00:00:00" --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 the list of available time zones and their IDs.

The id of the output can be used as timeZoneId in CreateJob, GetJobResults, SetJobSchedule and SendStatusReport and as timeZoneID (with a capital ID) in GetWorkerResults.


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

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

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

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

GetWorkerResultReport

Get the details of a profile execution result.

Arguments

Name Type Description
instanceID string Unique ID of MailStore instance in which this command is invoked.
id number The ID of the result for which the details should be fetched.

Use the GetWorkerResults command to get the IDs of results.

InitializeMFA

Initializes multi-factor authentication of a user. The user has to scan a QR code with a TOTP compatible app and has to enter an MFA code to be able to login. When InitializeMFA is called when MFA is already active for a user, a new secret is generated and the user has to scan the QR code again. This also invalidates all trusted device tokens of a user.

Arguments

Name Type Description
instanceID string Unique ID of MailStore instance in which this command is invoked.
userName string The user name of the user for whom MFA shall be initialized.

DisableMFA disables multi-factor authentication of a user.

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.

SendStatusReport

Send a status report to the given recipients.

Arguments

Name Type Description
instanceID string Unique ID of MailStore instance in which this command is invoked.
timespan string Timespan that is covered by the status report.
timeZoneId string The id of the time zone the date should be converted to, e.g. $Local, which represents the time zone of the operating system.
recipients string Comma separated list of recipients that will receive the status report.

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

Argument Values

Timespan

Name Description
today The day when the status report is sent.
yesterday The day before the status report is sent.
thisweek The week when the status report is sent.
lastweek The week before the status report is sent.
thismonth The month when the status report is sent.
lastmonth The month before the status report is sent.


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.

SetProfileServerSideExecution

Disables or enables the automatic server-sided execution with its parameters.

Arguments

Name Type Description
instanceID string Unique ID of MailStore instance in which this command is invoked.
id number The unique profile ID of the profile to be modified.
automatic bool Enables (true) or disables (false) the profile's server-side automation.
automaticPauseBetweenExecutions number (optional) Integer value (0 - 2147483647) of seconds to pause between re-executing an automatic profile.
automaticMaintenanceWindows string (optional) TimeSpan string (hh:mm-hh:mm, e.g. 22:00-04:00) for the time window where the execution should not be executed, e.g. to schedule maintenance tasks.

Use the API command GetProfiles to retrieve a list of all profiles and their current "serverSideExecution" section details.

The command can be executed with either the argument automatic=false and no additional parameters to disable the automation, or with automatic=true and at least the automaticPauseBetweenExecutions value given. The automaticMaintenanceWindows parameter is optional. Setting an already automated profile to automatic again, will restart the profile.

SetSmtpSettings

Set SMTP configuration.

Arguments

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]",
  "recipientEmailAddresses": ["[email protected]", "[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.

SetUserLoginPrivileges

Set login privileges 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.
loginPrivileges string Comma separated list of login privileges.

Argument Values

loginPrivileges

Name Description
none The user is granted no login privileges. If specified, this value has to be the only value in the list.
windows The user is allowed to use the Windows Client.
web The user is allowed to use the Web Access.
outlook The user is allowed to use the Outlook Add-in.
windowsCmd The user is allowed to use scheduled tasks and the command line client of MailStore Client.
imap The user is allowed to access the archive using IMAP.

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.
Retrieved from "https://help.mailstore.com/en/spe/index.php?title=Management_API_-_Function_Reference&oldid=2068"