MailStore Server Management Shell

The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

Many instructions available in the graphical user interface of MailStore Client can also be executed using MailStore's management shell, a command line client which is automatically included when installing MailStore Server and MailStore Client.

The management shell is useful when no graphical user interface is available (e.g. if using telnet or ssh) or for the integration of scripts (e.g. batch files) that are executed either manually or automatically.

Beside the client-side commands, the Management Shell also offers access to server-side commands of the MailStore Server Administration API. Output of server-side commands is in JSON format.

Starting the Management Shell in MailStore Client

The management shell can be started directly from MailStore: Log on to MailStore Client as administrator and click on Administrative Tools > Management API > Command Prompt.

The font size can be adjusted by holding the Ctrl key and using the mouse wheel or pressing + and -. Holding down the Ctrl key and pressing 0 resets the font size.

Using MailStoreCmd.exe in Non-Interactive Mode

In non-interactive mode, the management shell logs on with the access data passed, executes the command passed, and automatically terminates upon execution. If the login and the execution of the command were successful, the exit code (ERRORLEVEL) of the process is set to 0 (zero), otherwise it is set to any value other than 0. MailStoreCmd.exe can be found in the installation directory of MailStore Server. MailStoreCmdSilent.exe does the same, but does not open a console window.

Login credentials for your installation can be found in the scheduled task of an archiving profile of the type E-Mail Programs or E-Mail Files.

There are multiple ways to pass credentials to MailStoreCmd.exe.

To read credentials from the Windows Credentials Manager, they have to be stored there first. The MailStore Client does this automatically when creating a scheduled task in the Windows Task Planer. This methods prevents reading passwords easily by unauthorized persons.

MailStoreCmd.exe --h=<server> --cred=<user>@<server/ip address> --pkv3=<thumbprint> -c <command> [--param1=<value> --param2=<value> ...]

The credentials can also be passed as plain text.

MailStoreCmd.exe --h=<server> --u=<user> --p=<password> --pkv3=<thumbprint> -c  <command> [--param1=<value> --param2=<value> ...]

The below command line parameters are required followed by additional API command parameters if necessary.

Parameter	Description
`--h`	The machine name of the MailStore server to which `MailStoreCmd.exe` is to connect.
`--pkv3`	The (optional) Public Key Fingerprint, which guarantees the identity of MailStore Server.
`--u`	User name
`--p`	Password
`--cred`	Alternative to `--u` and `--p`, the password is read from the Windows Credential Manager. The parameter must be entered in the from <user>@<server/ip address>.
`--nologo`	Optional. Prevents the logo from being displayed.
`--o`	Optional. Redirects the output to a given file. When this parameter is given, no output is sent to the console. The placeholders {DATE} and {TIME} are replaced with the current date and time at execution time.
`-c`	The actual command follows (non-interactive mode). This must be the last parameter.

Command Overview

Client side commands

Find a list of all client side commands below.

 clear

Clears the texts currently displayed improving visibility.

 debug-conn

Activates debug protocol for IMAP and HTTP connections during archiving for the running MailStore Client process.

 debuglog-browse

Opens the file explorer and shows MailStore's Debug Log directory.

 debuglog-enable,  debuglog-disable

Activates or deactivates the global debug protocol (within computer scope).

 export-execute [--name=<profilename>] [--id=<profileid>] [--verbose] [--[property]="value"]

Executes an export profile. Following parameters are supported:

`--name` \| `--id`	name or ID of the export profile to execute
`--verbose`	activates a detailed status display on the console
`--[property]`	Overwrites the given property of a profile. The internal properties can be displayed, by selecting an export profile and press `CTRL + SHIFT + P`. The name of the property has to be in brackets. Multiple properties can be modified by repeating the parameter.

 export-list

Displays a list of all existing export profiles (ID and profile name).

 help

Displays a list of all available commands and their parameters.

 import-execute [--name=<profilename>] [--id=<profileid>] [--verbose] [--user=<username>] [--[property]="value"]

Executes the archiving profile. Following parameters are supported:

`--name` \| `--id`	name or ID of the import profile to execute
`--verbose`	activates a detailed status display on the console
`--user`	user archive to store archived emails
`--[property]`	Overwrites the given property of a profile. The internal properties can be displayed, by selecting an archiving profile and press `CTRL + SHIFT + P`. The name of the property has to be in brackets. Multiple properties can be modified by repeating the parameter.

 import-list [--user=<username>]

Displays a list of all existing archiving profiles (ID and profile name).

 livelog-client-disable,  livelog-client-enable,  livelog-server-disable,  livelog-server-enable

Activates or deactivates the live debug protocol of MailStore Server or MailStore Client. The live protocol can be viewed with Sysinternal's DebugView. DebugView must be started with elevated privileges and it must be configured to capture Global Win 32 events.

 store-setprop --name=<name> [--value=true/false]

Changes the value of a global property

`--name`	Name of the global property
`--value`	Value of the global property

Following global properties are supported:

Name	Values	Default
public.arcclient.skipMimeContentConversionFailed	true = Exchange MimeContentConversionFailed errors are ignored and not handled as an archiving error. false = Exchange MimeContentConversionFailed errors are handled as archiving errors.	false
public.arcclient.skipVirusDetected	true = Exchange ErrorVirusDetected errors are ignored and not handled as an archiving error. false = Exchange ErrorVirusDetected errors are handled as archiving errors.	false
public.arcclient.skipEwsErrorItemNotFound	true = Exchange ErrorItemNotFound errors are ignored and not handled as an archiving error. false = Exchange ErrorItemNotFound errors are handled as archiving errors.	false
public.backup.hideNotDetectedWarningMessage	true = Backup warning messages are not shown on dashboard. false = Backup warning messages are shown on dashboard.	false

 user-list

Display list of users.

Server side commands

An overview of all available server side commands can be found under Function Reference.

The parameters of server side commands are case sensitive and must be entered with two dashes (--). Boolean values must be entered as true or false. Strings that contain white space characters must be set in quotes.

Examples:

GetProfiles --raw=true

Lists all archiving and export profiles.

GetUserInfo --userName="alexis.page"

Lists the properties of the user alexis.page.

GetJobResults --fromIncluding="2018-01-01T00:00:00" --toExcluding="2019-01-01T00:00:00" --timeZoneId="$Local" --jobId=1

Lists the results of the job with id 1 of the year 2018.

GetWorkerResults --fromIncluding="2018-01-01T00:00:00" --toExcluding="2019-01-01T00:00:00" --timeZoneID="$Local" --profileID=1

Lists the results of the archiving profile with id 1 of the year 2018. The command GetWorkerResults is the only command where the parameter timeZoneID is written with a capital D.

RunProfile --id=1

Starts the archiving or export profile with id 1.