Difference between revisions of "Administration API - Function Reference"
| [unchecked revision] | [unchecked revision] |
| Line 1,298: | Line 1,298: | ||
== TestSmtpSettings == | == TestSmtpSettings == | ||
| − | |||
Test current SMTP configuration. | Test current SMTP configuration. | ||
Revision as of 13:26, 26 October 2017
AttachStore
Attach existing archive store.
Arguments
| Name | Type | Description |
|---|---|---|
| name | string | Meaningful name of archive store. |
| type | string (optional) | |
| databaseName | string (optional) | Name of database on Microsoft SQL Server or PostgreSQL server. |
| databasePath | string (optional) | Path to directory in which database folder information and email meta data are stored. |
| contentPath | string (optional) | Path to directory in which email headers and contents are stored. |
| indexPath | string (optional) | Path to directory in which full text search indexes are stored. |
| serverName | string (optional) | Name of Microsoft SQL Server or PostgreSQL server. |
| userName | string (optional) | User name for accessing Microsoft SQL Server or PostgreSQL server. |
| password | string (optional) | Password for accessing Microsoft SQL Server or PostgreSQL server. |
| requestedState | string (optional) | State of archive store after attaching. |
Argument Values
type
| Name | Description |
|---|---|
| FileSystemInternal | Advanced file system-based archive store. |
| SQLServer | Microsoft SQL Server-based arechive store. |
| PostgreSQL | PostgreSQL server-based archive store. |
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. |
CancelJobAsync
Cancel a running job asynchronously.
Arguments
| Name | Type | Description |
|---|---|---|
| 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 |
|---|---|---|
| userName | string | User name of MailStore user. |
CompactMasterDatabase
Compact master database.
CompactStore
Compact archive store.
Arguments
| Name | Type | Description |
|---|---|---|
| id | number | Unique ID of archive store |
CreateBackup
Create a backup of the entire archive.
Arguments
| Name | Type | Description |
|---|---|---|
| path | string | Path to directory into which the backup should be written. |
| excludeSearchIndexes | bool (optional) | Indicates whether the search index files should be excluded from the backup. |
CreateJob
Create a new job to execute Management API commands.
Arguments
| Name | Type | Description |
|---|---|---|
| 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 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. |
Argument Values
dayOfWeek
| Name | Description |
|---|---|
| Sunday | Sunday |
| Monday | Monday |
| Tuesday | Tuesday |
| Wednesday | Wednesday |
| Thursday | Thursday |
| Friday | Friday |
| Saturday | Saturday |
dayOfMonth
| Name | Description |
|---|---|
| 1 to 31 | Numeric represation of day of month. |
| Last | Last day of month. |
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. |
CreateProfile
Create a new archiving or exporting profile.
Arguments
| Name | Type | Description |
|---|---|---|
| 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 then use the GetProfiles method to receive supported values. The properties id and version must be omitted, the password field must be filled properly.
CreateStore
Create and attach a new archive store.
Arguments
| Name | Type | Description |
|---|---|---|
| name | string | Meaningful name of archive store. |
| type | string (optional) | |
| databaseName | string (optional) | Name of database on Microsoft SQL Server or PostgreSQL server. |
| databasePath | string (optional) | Path to directory in which database folder information and email meta data are stored. |
| contentPath | string (optional) | Path to directory in which email headers and contents are stored. |
| indexPath | string (optional) | Path to directory in which full text search indexes are stored. |
| serverName | string (optional) | Name of Microsoft SQL Server or PostgreSQL server. |
| userName | string (optional) | User name for accessing Microsoft SQL Server or PostgreSQL server. |
| password | string (optional) | Password for accessing Microsoft SQL Server or PostgreSQL server. |
| requestedState | string (optional) | State of archive store after attaching. |
Argument Values
type
| Name | Description |
|---|---|
| FileSystemInternal | Standard archive store. |
| SQLServer | Microsoft SQL Server-based arechive store. |
| PostgreSQL | PostgreSQL server-based archive store. |
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. |
CreateUser
Create new MailStore user.
Arguments
| Name | Type | Description |
|---|---|---|
| userName | string | User name of new MailStore user. |
| privileges | string | Comma separated list of privileges. |
| fullName | string (optional) | Full name of user. |
| distinguishedName | string (optional) | LDAP DN string. |
| authentication | string (optional) | Authentication setting for user: 'integrated or 'directoryServices'. |
| password | string (optional) | Password of new user. |
DeleteEmptyFolders
Remove folders from folder tree that do not contain emails.
Arguments
| Name | Type | Description |
|---|---|---|
| folder | string (optional) | Entry point in folder tree. |
DeleteJob
Deletes a job.
Arguments
| Name | Type | Description |
|---|---|---|
| id | string (optional) | The uniqe identifier of the job to be deleted. |
DeleteMessage
Delete a single message
Arguments
| Name | Type | Description |
|---|---|---|
| id | string (optional) | Unique ID of message. Format: <store_id>:<message_num> |
DeleteProfile
Delete an archiving or exporting profile.
Arguments
| Name | Type | Description |
|---|---|---|
| id | number | Unique ID of profile. |
DeleteUser
Delete a MailStore user.
Arguments
| Name | Type | Description |
|---|---|---|
| userName | string | User name of MailStore user. |
DetachStore
Detach archive store
Arguments
| Name | Type | Description |
|---|---|---|
| id | number | Unique ID of archive store. |
GetActiveSessions
Get list of current user sessions.
GetChildFolders
Get child folders.
Arguments
| Name | Type | Description |
|---|---|---|
| folder | string (optional) | Parent folder. |
| maxLevels | number (optional) | Depth of child folders. |
GetComplianceConfiguration
Get current compliance configuration settings.
GetDirectoryServicesConfiguration
Get current Directory Services configuration settings.
GetFolderStatistics
Get folder statistics.
GetJobResults
Retrieves list of finished job executions.
Arguments
| Name | Type | Description |
|---|---|---|
| fromIncluding | string | Beginning of time range to fetch. |
| toExcluding | string | End of time range to fetch. |
| timeZoneId | string | Time zone in which timestamp should be returned. |
| JobId | number (optional) | The job id for which to retrieve results. |
Interactive Management Shell Example: GetJobResults --fromIncluding="2016-12-01T00:00:00" --toExcluding="2016-12-31T23:59:59" --timeZoneId="$Local" --JobId=1
GetJobs
Retrieve list of jobs
GetMessages
Get list of messages from a folder.
Arguments
| Name | Type | Description |
|---|---|---|
| folder | string (optional) | Folder whose content to list. |
GetProfiles
Get list of archiving and exporting profiles.
Arguments
| Name | Type | Description |
|---|---|---|
| raw | bool | Currently only 'true' is supported. |
GetServerInfo
Get MailStore Server version and machine name.
GetServiceConfiguration
Get MailStore Server service configuration. This includes the path to the Master Database, the location of the audit log, whether the different debug logs are enabled and the endpoint configuration.
GetSmtpSettings
Get current SMTP configuration.
GetStoreIndexes
Get list of attachment file types to index.
Arguments
| Name | Type | Description |
|---|---|---|
| id | number (optional) | Unique ID of archive store. |
GetStores
Get list of archive stores.
GetTimeZones
Get list of available time zones.
GetUserInfo
Get detailed information about user.
Arguments
| Name | Type | Description |
|---|---|---|
| userName | string | User name of MailStore user |
GetUsers
Get list of users.
GetWorkerResults
Get results of profile executions.
Arguments
| Name | Type | Description |
|---|---|---|
| fromIncluding | string | Beginning of time range to fetch. |
| toExcluding | string | End of time range to fetch. |
| timeZoneID | string | Time zone in which timestamp should be returned. |
| profileID | number (optional) | Filter results by given profile ID. |
| userName | string (optional) | Filter results by given user name. |
MaintainFileSystemDatabases
Run database maintainance on all datbases of file system based archive stores.
MergeStore
Merge two archive stores.
Arguments
| Name | Type | Description |
|---|---|---|
| id | number | Unique ID of destination archive store. |
| sourceId | number | Unique ID of source archive store. |
MoveFolder
Move folder.
Arguments
| Name | Type | Description |
|---|---|---|
| fromFolder | string | Old folder name. |
| toFolder | string | New folder name. |
RebuildSelectedStoreIndexes
Rebuild all full-text indexes selected for rebuild.
RebuildStoreIndex
Rebuild search index for given archive folder.
Arguments
| Name | Type | Description |
|---|---|---|
| id | number | Unique ID of archive store. |
| folder | string | Name of folder name. |
RefreshAllStoreStatistics
Refresh statistics of all archive stores.
RenameJob
Rename job.
Arguments
| Name | Type | Description |
|---|---|---|
| id | number (optional) | The unique identifier of the job to be renamed. |
| name | string (optional) | The new job name. |
RenameStore
Rename archvive store
Arguments
| Name | Type | Description |
|---|---|---|
| id | number | Unique ID of archive store. |
| name | string | New name of archive store. |
RenameUser
Rename a MailStore user.
Arguments
| Name | Type | Description |
|---|---|---|
| oldUserName | string | Old user name. |
| newUserName | string | New user name. |
RenewMasterKey
Renews the master key which is used to encrypt the encryption keys.
RetryOpenStores
Retry opening stores that failed previously.
RunJobAsync
Run an existing job.
Arguments
| Name | Type | Description |
|---|---|---|
| id | number | The identifier of the job to be run. |
RunProfile
Run an existing archiving or exporting profile.
Arguments
| Name | Type | Description |
|---|---|---|
| id | number | Unique profile ID. |
RunTemporaryProfile
Run a temporary/non-existent profile.
Arguments
| Name | Type | Description |
|---|---|---|
| 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.
SelectAllStoreIndexesForRebuild
Select all full-text indexes for rebuild.
SetComplianceConfiguration
Set compliance configuration settings.
Arguments
| Name | Type | Description |
|---|---|---|
| config | json | Compliance configuration. |
Argument Values
config
Use GetComplianceConfiguration to receive supported value.
SetDirectoryServicesConfiguration
Set directory services configuration settings.
Arguments
| Name | Type | Description |
|---|---|---|
| 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 |
|---|---|---|
| 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 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. |
Argument Values
dayOfWeek
| Name | Description |
|---|---|
| Sunday | Sunday |
| Monday | Monday |
| Tuesday | Tuesday |
| Wednesday | Wednesday |
| Thursday | Thursday |
| Friday | Friday |
| Saturday | Saturday |
dayOfMonth
| Name | Description |
|---|---|
| 1 to 31 | Numeric represation of day of month. |
| Last | Last day of month. |
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. |
SetSmtpSettings
Set SMTP configuration.
Arguments
| Name | Type | Description |
|---|---|---|
| settings | json | SMTP configuration. |
SetStoreProperties
Set properties of archive store.
Arguments
| Name | Type | Description |
|---|---|---|
| id | number | Set properties of archive store. |
| type | string (optional) | |
| databaseName | string (optional) | Name of database on Microsoft SQL Server or PostgreSQL server. |
| databasePath | string (optional) | Path to directory in which database folder information and email meta data are stored. |
| contentPath | string (optional) | Path to directory in which email headers and contents are stored. |
| indexPath | string (optional) | Path to directory in which full text search indexes are stored. |
| serverName | string (optional) | Name of Microsoft SQL Server or PostgreSQL server. |
| userName | string (optional) | User name for accessing Microsoft SQL Server or PostgreSQL server. |
| password | string (optional) | Password for accessing Microsoft SQL Server or PostgreSQL server. |
Argument Values
type
| Name | Description |
|---|---|
| FileSystemInternal | Advanced file system-based archive store. |
| SQLServer | Microsoft SQL Server-based arechive store. |
| PostgreSQL | PostgreSQL server-based archive store. |
SetStoreRequestedState
Set state of archive store.
Arguments
| Name | Type | Description |
|---|---|---|
| id | number | Unique ID of archvie store. |
| 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. |
SetUserAuthentication
Set authentication settings of a MailStore user.
Arguments
| Name | Type | Description |
|---|---|---|
| userName | string | User name of MailStore user. |
| authentication | string | Authentication method. Either 'inegrated' or 'directoryServices'. |
SetUserDistinguishedName
Set the LDAP distinguished name of a MailStore user.
Arguments
| Name | Type | Description |
|---|---|---|
| userName | string | User name of MailStore user. |
| distinguishedName | string (optional) | LDAP DN string. |
SetUserEmailAddresses
Set email addresses of MailStore user.
Arguments
| Name | Type | Description |
|---|---|---|
| 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 |
|---|---|---|
| userName | string | User name of MailStore user. |
| fullName | string (optional) | Full name of MailStore user. |
SetUserPassword
Set password of MailStore user.
Arguments
| Name | Type | Description |
|---|---|---|
| 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 |
|---|---|---|
| userName | string | User name of MailStore user. |
| pop3UserNames | string (optional) | Comma seperated list of POP3 user names. |
SetUserPrivileges
Set privileges of MailStore user.
Arguments
| Name | Type | Description |
|---|---|---|
| userName | string | User name of MailStore user. |
| privileges | string | Comma separated list of privileges. |
SetUserPrivilegesOnFolder
Set privileges on folder for MailStore user.
Arguments
| Name | Type | Description |
|---|---|---|
| userName | string | User name of MailStore user. |
| folder | string | Folder name. |
| privileges | string | Comma separated list of folder privileges. |
SyncUsersWithDirectoryServices
Sync users of MailStore instance with directory services.
Arguments
| Name | Type | Description |
|---|---|---|
| dryRun | bool (optional) | Simulate sync only. |
TestSmtpSettings
Test current SMTP configuration.
UpgradeStore
Upgrade archive store from MailStore Server 5 or older to current format.
Arguments
| Name | Type | Description |
|---|---|---|
| id | number | Unique ID of archive store. |
VerifyStore
Verify archive stores consistency.
Arguments
| Name | Type | Description |
|---|---|---|
| id | number | The uniqe identifier of the archive store to be verified. |
VerifyStores
Verify consistency of all archive stores.
