Difference between revisions of "Branding"

[checked revision]

Revision as of 09:46, 19 January 2024

The appearance of MailStore Client, MailStore Web Access, and MailStore Outlook Add-in can be customized easily 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.
The title of the index.html page must be configured in index.html. That page is shown when the Client Access Server (CAS) is accessed without any instance ID.
Log on to the Management Console, if not already logged on.
Navigate to Navigation > Developer > Management API and select ReloadBranding from the drop down menu then press Invoke to activate the new branding.

Limitations

Some parts of the Client and Outlook Add-in cannot be branded as they are an integral part of the digitally signed installer packages (e.g. program icons) or are used at an early stage, where no branding information is available yet, like the Connect to E-mail Archive dialog.

While the limited supported parameters allow to quickly create a decent branding without having to deal with CSS at all, not all color schemes are suitable to be used. Thus, a general recommendation is to use darker colors for backgrounds as certain non-brandable text color are white.

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 and hover color of buttons, e.g. "#126d9c". Darker colors are recommended as some texts are using a non-brandable white color.
`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
`gatewayName`	Custom name that the MailStore Gateway archiving profile is listed under.

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.
`webRoot_html`	HTML file to be used when no in instance was given in the URL.
`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 and hover color of buttons, e.g. "#126d9c". Darker colors are recommended as some texts are using a non-brandable white color.
`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
`favicon_ico`	Favicon in 16x16, 32x32, 64x64 pixel.
`favicon_png`	Favicon in 196x196 pixel in PNG format.
`highlightColor`	Color used for section titles, buttons and other controls, e.g. "#6aabce".

@@ Line 10: / Line 10: @@
 * 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 (byte order mark) or else it cannot be loaded.
+* The ''title'' of the ''index.html'' page must be configured in ''index.html''. That page is shown when the Client Access Server (CAS) is accessed without any instance ID.
 * [[Management Console - Logging On#Logging On|Log on]] to the Management Console, if not already logged on.
 * Navigate to ''Navigation > Developer > Management API'' and select ''ReloadBranding'' from the drop down menu then press ''Invoke'' to activate the new branding.