Customizing the generated email for encrypted or private mail

To enforce security settings, some emails only sync to HCL clients. This includes Notes-encrypted mails and mails marked as private (prevent copy). For any third party client (for example, the iOS Mail app), Traveler syncs a placeholder email indicating that the mail can be viewed with another client.

Here is an example of the default email content synced to the iOS mail application for a mail marked as prevent copy (updated for HCL Traveler 12.0.2):

This document is set to prohibit copying and duplicating and cannot be viewed using this application. View the content on the device using one of the following option(s):

  • Traveler Companion. If Traveler Companion is not yet installed, download and install it from the app store.
  • Verse mobile application. If the Verse mobile application is not yet installed, download and install it from the app store.
  • Notes, Nomad or the Verse web client.
Though the administrator cannot customize the strings that make up the generated email, the administrator has control over which options are included in the email. Depending upon the client and OS platform, the administrator-controlled options are to include one or more of the following options in the generated email:
  • HCL Companion for iOS
  • HCL Verse for iOS
  • Other HCL clients (Notes, Nomad, or Verse web)

Customizing client options

Starting with HCL Traveler Server 12.0.2, a series of NTS_ENCRYPTED_MAIL_APP_* notes.ini settings are provided to allow the administrator to control the contents of the generated email.

  • NTS_ENCRYPTED_MAIL_APP_COMPANION – use the HCL Companion for iOS application to work with the mail
  • NTS_ENCRYPTED_MAIL_APP_VERSE – use the HCL Verse for iOS application to work with the mail
  • NTS_ENCRYPTED_MAIL_APP_OTHER – use HCL Notes, HCL Nomad, or HCL Verse (web) to work with the mail.
The same settings control the content for both Notes-encrypted mail as well as mail marked as prevent copy. The administrator should select which option best fits the customer strategy for working with encrypted and prevent copy mails. For example, if users should use HCL Verse for iOS to work with these mails, then the administrator can choose to disable a reference using Companion by setting NTS_ENCRYPTED_MAIL_APP_COMPANION to false. Any combination can be included or excluded via the NTS_ENCRYPTED_MAIL_APP_* notes.ini settings. By default, all are enabled.
Note: Only options that are applicable to the client and OS platform are included.
At a minimum, the generated email contains this initial explanation of why the contents of the mail are missing:
  • For encrypted mail: This document is encrypted and cannot be viewed using this application.
  • For mails marked as private: This document is set to prohibit copying and duplicating and cannot be viewed using this application
The rest of the mail depends on the options enabled and applicability to the client and platform. The following are some examples:
  1. To reference only HCL Companion (similar to pre-12.0.2 behavior):
    • NTS_ENCRYPTED_MAIL_APP_COMPANION = true
    • NTS_ENCRYPTED_MAIL_APP_VERSE = false
    • NTS_ENCRYPTED_MAIL_APP_OTHER = false
    Resulting generated email contents:

    This document is encrypted and cannot be viewed using this application. View the content on the device using one of the following option(s):

    Traveler Companion. If Traveler Companion is not yet installed, download and install it from the app store.
  2. Use HCL Verse for iOS or Notes:
    • NTS_ENCRYPTED_MAIL_APP_COMPANION = false
    • NTS_ENCRYPTED_MAIL_APP_VERSE = true
    • NTS_ENCRYPTED_MAIL_APP_OTHER = true
    Resulting generated email contents:

    This document is set to prohibit copying and duplicating and cannot be viewed using this application. View the content on the device using one of the following option(s):

    • Verse mobile application. If the Verse mobile application is not yet installed, download and install it from the app store.
    • Notes, Nomad or the Verse web client.
  3. Turn off all options
    • NTS_ENCRYPTED_MAIL_APP_COMPANION = false
    • NTS_ENCRYPTED_MAIL_APP_VERSE = false
    • NTS_ENCRYPTED_MAIL_APP_OTHER = false
    Resulting generated email contents:
    This document is encrypted and cannot be viewed using this application.

Customizing download links

When the client is the iOS Mail app, either the HCL Companion for iOS and/or HCL Verse for iOS app is applicable for working with the mail content. Client application download information, by default, is provided in the content. This download information can be customized for both apps. There are three groups of settings to affect the download information:

Include a clickable link?

Controlling whether a clickable link to the app store is included can be controlled separately for HCL Companion and HCL Verse each using these notes.ini settings:

  • NTS_COMPANION_INCLUDE_INSTALL_LINK=true/false
  • NTS_VERSE_INCLUDE_INSTALL_LINK=true/false

If, for example, NTS_COMPANION_INCLUDE_INSTALL_LINK=false, then the associated download text will be: If Traveler Companion is not yet installed, download and install it from the app store.

Customize the clickable link?

By default, the download links for the HCL Companion for iOS and HCL Verse for iOS apps are their respective Apple app store links. To change the link, for example, to an enterprise application store, set one or both of the following:

  • NTS_COMPANION_INSTALL_LINK_APP_STORE – Install link for HCL Companion for iOS
  • NTS_CLIENT_INSTALL_LINK_APPLE_IBM_APP_STORE – Install link for HCL Verse for iOS
Note: Customized links are ignored if NTS_COMPANION_INCLUDE_INSTALL_LINK=false or NTS_VERSE_INCLUDE_INSTALL_LINK=false.

Customize the application store name?

Whether the link is clickable or not, it is possible to specify a custom app store name by using the notes.ini NTS_CLIENT_INSTALL_COMPANY_APP_STORE_NAME setting. This value is used in place of the generic “app store” value in the download text.

Examples:

The following show some combinations of the notes.ini settings with the resulting generated download information:
  1. Use HCL Companion only, no customization of the download site:
    Resulting generated email contents:

    This document is encrypted and cannot be viewed using this application. View the content on the device using one of the following option(s):

    • Traveler Companion. If Traveler Companion is not yet installed, download and install it from the app store.
  2. Use HCL Verse only. For the download site, customize using a company’s enterprise app store:
    • NTS_ENCRYPTED_MAIL_APP_COMPANION = false
    • NTS_ENCRYPTED_MAIL_APP_VERSE = true
    • NTS_ENCRYPTED_MAIL_APP_OTHER = false
    • NTS_VERSE_INCLUDE_INSTALL_LINK = true
    • NTS_CLIENT_INSTALL_COMPANY_APP_STORE_NAME = acme
    • NTS_CLIENT_INSTALL_LINK_APPLE_IBM_APP_STORE = https://acme.com/app/hcl-verse/id949952976
    Resulting generated email contents:

    This document is encrypted and cannot be viewed using this application. View the content on the device using one of the following option(s):

    • Verse mobile application. If the Verse mobile application is not yet installed, download and install it from the acme app store.
    Note: HCL Verse for iOS does not support a launch link for a specific document. The link provided is for downloading the application.
  3. Using HCL Verse only. Customize the store name but do not provide a download link:
    • NTS_ENCRYPTED_MAIL_APP_COMPANION = false
    • NTS_ENCRYPTED_MAIL_APP_VERSE = true
    • NTS_ENCRYPTED_MAIL_APP_OTHER = false
    • NTS_VERSE_INCLUDE_INSTALL_LINK = false
    • NTS_CLIENT_INSTALL_COMPANY_APP_STORE_NAME = acme
    Resulting generated email contents:

    This document is encrypted and cannot be viewed using this application. View the content on the device using one of the following option(s):

    • Verse mobile application. If the Verse mobile application is not yet installed, download and install it from the acme app store.
    Note: Even if a value had been set for NTS_CLIENT_INSTALL_LINK_APPLE_IBM_APP_STORE, it is ignored because NTS_VERSE_INCLUDE_INSTALL_LINK = false.

For backwards compatibility, it is possible to set the download link setting for HCL Companion or Verse to the string “MyStore”. If set, then the download text is not clickable. The resulting download text is as follows:

If Traveler Companion is not yet installed, download and install it from your company's app store.
Setting NTS_CLIENT_INSTALL_COMPANY_APP_STORE_NAME=acme changes this text to:
If Traveler Companion is not yet installed, download and install it from the acme app store.

For more information on each setting, see Notes.ini settings. For information on using HCL Companion, see How do I view and send encrypted mail?.