Home » Knowledgebase » MailStore – How to use the API when working with MailStore profiles

MailStore – How to use the API when working with MailStore profiles

ID: 13558

Summary

In MailStore, how can you get the current settings of archiving profiles via the application programming interface (API)?

This issue was reported in (but may not be limited to):

MailStore Server
MailStore Service Provider Edition (SPE)

Resolution

Use the following command to get the settings of the current MailStore profiles:

GetProfiles --raw=true

For the CreateProfile command, use the JSON output as received from the GetProfiles command as a string. Remove the “id” and “version” part, replace all quotes (“) with single quotes (‘), and enter a password.

CreateProfile --raw=true --properties="json string"

Example:

CreateProfile --raw=true --properties="{'owner': 'admin', 'type': 'I', 'connector': 'Exchange', ..."

Additional Information

For more information about MailStore specific application programming interface (API) please visit the MailStore product help pages as listed below:

MailStore Server – Topic “Administration API”
MailStore Service Provider Edition – Topic “Management API”