Administration API - Function Reference

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

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.

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

CreateProfile

Create a new archiving or exporting profile.

Arguments

Name	Type	Description
properties	json	Profile properties.
raw	bool	Currently only 'true' is supported.

CreateStore

Create and attach a new archive store.

Arguments

Name	Type	Description
name	string	Meaningful name of archive store.
type	string
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

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: 'Standard' or 'DirectoryService'.
password	string (optional)	Password of new user.

DeleteEmptyFolders

Remove folders from folder tree that do not contain emails.

Arguments

Name	Type	Description
folder	string (optional)	Entry point in folder tree.

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.

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.

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.

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.

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.

RetryOpenStores

Retry opening stores that failed previously

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.

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.

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.

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 'Standard' or 'Windows Authentication'.

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.

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	Unique ID of archive store.