EmailSentry V03 Configuration

EmailSentry™ V03 Configuration

This document describes configuration for EmailSentry V03, the Outlook (New Outlook for Windows) version (whish is also for MAC, browser, and mobile devices). Configuration for EmailSentry V02, the Outlook Classic (Classic Outlook for Windows) version, also called a "COM Add-in", are at EmailSentry V02 Configuration.

EmailSentry V03 is configured in a ConfigFile that specifies what feature/functionality is offered and how it is performed. The ConfigFile is a JSON document and must be a valid JSON.

The ConfigFile controls two things: the EmailSentry Add-in itself, and the //email/testTo: ("TestReceiver") webservice that EmailSentry uses.

Control EmailSentry

The ConfigFile controls several EmailSentry settings:

CONFIGURL: URL of next config file to load. Used in FixedConfigFile to find the LiveConfigFile.xml (see below "Where is the ConfigFile and how is it updated?") (default is https://www.checktls.com/CsOA/YOURCSOACODE/LiveConfigFile.xml).
DISABLE: 0(default) or 1, 1 to completely disable EmailSentry.
SKIPDOMAIN: domains that you do not want to test like your own domains or other trusted email partners (default is empty). Multiple domains may be listed in multiple SKIPDOMAIN nodes or together in one SKIPDOMAIN node separated by semi-colons (";"), or a combination of both.
NOTFROM: Outlook accounts ("From:" addresses) on which you do not want EmailSentry. Used when Outlook has multiple accounts and don't want EmailSentry to popup when sending from one or more of them.
TIMEOUT: how long EmailSentry waits for CheckTLS servers to respond (default is 30 seconds).
MINSCORE: tells EmailSentry what TestReceiver ConfidenceFactor (i.e. the score) you consider “secure” (default is 90). See Confidence Factor℠ for details.
SILENT: 0(default) or 1, 1 to suppress the display of the "working" spinner and the "checking..." message.
SENDMODE: "PromptUser"(default) or "SoftBlock", set to "SoftBlock" to disable "Send Anyway"
NODOMAINCACHE: 0(default) or 1, 0 checks each recipient domain as it is typed, 1 wait and check all domains when user clicks Send

Control //email/testTo: ("TestReceiver")

The ConfigFile also controls the //email/testTo: ("TestReceiver") test that is the foundation of EmailSentry. All of the options, and thus all the capabilities, of the //email/testTo: test can be specified in a ConfigFile.

TestReceiver options are listed in a "TRARGS" setting best described by example:


TRARGS: [
  QUICK:"on",
  TIMEOUT:10,
  SSLVERSION:"SSLv23:!SSLv3:!SSLv2:!TLSv1:!TLSv11"
]

See the expandable More Options section in the Instruction/Info for //email/testTo: for information about the options available, and TestReceiver API for the parameter names to use (remember to prefix them with "a_" in EmailSentry config).

Where is the ConfigFile and how is it updated?

The ConfigFile is stored on our servers. It is fetched and parsed by EmailSentry every time Outlook starts. This has two ramifications: one, the user must be connected to the Internet when they start Outlook (note that Outlook is not useful if the user is not connected to the Internet); and two, any changes to the ConfigFile ony requires that the user restart Outlook to get the new changes.

The ConfigFile stored on our servers can link to a ConfigFile hosted behind a company firewall where only company users can fetch it. Both ConfigFiles use the same format and are fetched every time Outlook restarts. Companies using EmailSentry use this to hide certain ConfigFile settings from the public. This might include things like SKIPDOMAINS, which are those domains that the company has decided are safe and do not need to be checked everytime an email is sent.

Editing ConfigFiles

Your ConfigFile stored on our servers is editable with //EmailSentry/editConfigFile. If you do use a linked ConfigFile, you can have your IT infrastructure supply different linked ConfigFiles, with different configuration options, to different departments, for example putting tighter controls on engineers than sales persons.

ConfigFile Format

The example below is a very full ConfigFile. Most of these are defaults and are not in a real ConfigFile; they are shown here for your information. See your specific ConfigFile for the few options that you do need. Here is the full ConfigFile: _config = { CONFIGURL: "https://MyDomain.com/EmailSentry/ConfigFile.js", // loads when encountered, can chain many of these ASKURL:"https://www.CheckTLS.com/AskEmailSentry", DISABLE:0, // disable ES3 NOTFROM: // disable ES3 for these users (e.g. use VSTO addin) [ "test@checktls.com" ], SILENT:0, // no spinner and checking... message SENDMODE:"PromptUser", // PromptUser (default), SoftBlock Block (cannot send even if ES3 fails to load) NODOMAINCACHE:0, // don't catch MessageRecipientsChanged event TIMEOUT:10, // EmailSentry MINSCORE:90, TRARGS: // TestReceiver parameters { QUICK:"on", //TIMEOUT:10, DONE BY QUICK // TestReceiver //IGNORENOCONNECT:"off", DONE BY QUICK //CHECKOCSP:"off", DONE BY QUICK //STOPAFTER:"EHLO2", DONE BY QUICK //MXCOUNT:1, DONE BY QUICK //TIMEOUT:11, DONE BY QUICK //SOCKS:"mailbox1-do.private.checktls.com:1080", //CACHEMIN:86400, // 1 day //CACHEMAX:604800, // 1 week SSLVERSION:"SSLv23:!SSLv3:!SSLv2:!TLSv1:!TLSv11" }, SKIPADDRESSES: // no ES3 checking for these full (mailbox@domain) addresses [ "/@forcetls.com$/i" // used with ENCRYPTOPTION forcetls.com ], SKIPDOMAINS: // no ES3 checking for these domains [ "TestSender.CheckTLS.com" ] };

Debug 3-dot Commands

There are a few hidden commands that we use to diagnose problems. They are triggered by entering special strings in the Subject: of an email and clicking Send. The email can be a live email that will be sent, or a dummy email, i.e. with an invalid address.

debug.debug.debug turns on debugging messages. EmailSentry will display information about what it is doing in popups as it processes the email. The email is sent. This setting stays on until you exit Outlook and restart it.

fullerrors.fullerrors.fullerrors displays all the information it has about an error it encounters. Normally error messages are summarized. The email is sent. This setting stays on until you exit Outlook and restart it.

version.version.version shows a one-time popup with the version string of EmailSentry installed on the user's PC. The email is not sent.

config.config.config puts the ConfigFile contents and all internal config variables into the body of the email. You are returned to editing the email.

uid.uid.uid puts the user's unique UID (one-way hash of their USERNAME and COMPUTERNAME) into the subject of the email. You are returned to editing the email.

test.test.test runs the message in "test" mode: normal testing is done but the final pop-up is displayed even if no errors are found, and the user must choose Change, Delete, or Send anyway.