Difference between revisions of "Branding"

[unchecked revision][unchecked revision]
m (about.html BOM notice added)
Line 9: Line 9:
 
* Create a new folder named <tt>Branding</tt>.
 
* Create a new folder named <tt>Branding</tt>.
 
* Store all files necessary for branding in this newly created folder. Find further details about the branding parameters in [[#Client Branding|Client Branding]] and [[#Web Branding|Web Branding]] below.
 
* Store all files necessary for branding in this newly created folder. Find further details about the branding parameters in [[#Client Branding|Client Branding]] and [[#Web Branding|Web Branding]] below.
*: '''Important notices:''' The dimensions of the images must remain unchanged and no syntax errors must be made when editing JSON files. If necessary, test the JSON files at http://jsonlint.com/. Sample files can be found in the ‘Branding.sample’ folder located in the ''config'' subdirectory. The ''about.html'' file needs to have an UTF-8 BOM or else it cannot be loaded.
+
*: '''Important notices:''' The dimensions of the images must remain unchanged and no syntax errors must be made when editing JSON files. If necessary, test the JSON files at http://jsonlint.com/. Sample files can be found in the ‘Branding.sample’ folder located in the ''config'' subdirectory. The ''about.html'' file needs to have an UTF-8 BOM (byte order mark) or else it cannot be loaded.
 
* Restart the Management Server service to activate the new branding.
 
* Restart the Management Server service to activate the new branding.
 
* Finally restart all the Client Access Server service on all server to refresh their local caches.
 
* Finally restart all the Client Access Server service on all server to refresh their local caches.

Revision as of 08:16, 1 July 2015

The appearance of MailStore Client, MailStore Web Access, and MailStore Outlook Add-in can all be easily customized to match your corporate design.

Modify and Activate Branding

Follow the instructions below to apply your own branding:

  • Open Windows Explorer on the Management Server.
  • Navigate to the config subdirectory of the MailStore Service Provider Edition installation. (Default: %PROGRAMFILES%\MailStore Infrastructure\config).
  • Create a new folder named Branding.
  • Store all files necessary for branding in this newly created folder. Find further details about the branding parameters in Client Branding and Web Branding below.
    Important notices: The dimensions of the images must remain unchanged and no syntax errors must be made when editing JSON files. If necessary, test the JSON files at http://jsonlint.com/. Sample files can be found in the ‘Branding.sample’ folder located in the config subdirectory. The about.html file needs to have an UTF-8 BOM (byte order mark) or else it cannot be loaded.
  • Restart the Management Server service to activate the new branding.
  • Finally restart all the Client Access Server service on all server to refresh their local caches.

Client Branding

The following table provides information about the fields available for MailStore Client branding stored in ClientBranding.json.

Name Description
clientName Name of the client application, e.g. "YOURCOMPANY - EMAIL ARCHIVE"
helpUrl URL to be opened when clicking on help in client.
loginHeaderImage_410x81_png Header image for login dialog. Required dimension: width: 410px; height: 81px
headerBackgroundColor Background color of header, e.g. "#126d9c"
headerLeftImage_autox95_png Left header image. Required dimension: width: auto; height: 95px
headerRightImage_autox95_png Right header image. Required dimension: width: auto; height: 95px
about_html HTML file containing the about site.
watermarkImage_300x150_png Watermark image. Required dimension: width: 300px; height: 150px

Web Branding

The following table provides information about the fields available for MailStore Web Access and MailStore Outlook Add-in branding stored in WebBranding.json.

Name Description
webName Name of the web application, e.g. "YOURCOMPANY - EMAIL ARCHIVE WEB ACCESS"
webAbout_html HTML file containing the about site.
webHelpUrl URL to be opened when clicking on help in web access.
webLoginHeaderImage_410x81_png Header image for login dialog. Required dimension: width: 410px; height: 81px
webHeaderBackgroundColor Background color of header, e.g. "#126d9c"
webHeaderBackgroundImage_autox36_png Header header image. Required dimension: width: auto; height: 36px
outlookAddinName Name of the Outlook Add-in, e.g. "YOURCOMPANY - EMAIL ARCHIVE ADD-IN"
outlookAddinHelpUrl URL to be opened when clicking on help in Outlook Add-in.
watermarkImage_300x150_png Watermark image. Required dimension: width: 300px; height: 150px

What to do next

Hereby the installation and setup process of the MailStore Service Provider Edition is finished. All other administrative tasks are carried out through the web-based MailStore Management Console.