JSON Configuration File

To customize the behavior of the Enki Outlook Classic Add-in, create a file named config.json and place it in the add-in's installation folder (Program Files\Eventus\Enki Outlook Add-in by default). If the file is missing or can't be parsed, the add-in falls back to its defaults — which means spam reporting and send-time warnings stay turned off until you configure them.

Example Configuration File

{
  "reportSpam": true,
  "promptSendToExternal": true,
  "spamReportConfig": {
    "buttonText": "Report Spam",
    "contextMenuText": "Report Spam",
    "promptMsg": "Are you sure you want to report this email?",
    "promptType": "simple",
    "completePrompt": "Thank you for reporting this email.",
    "submitTo": "[email protected]",
    "promptSend": false,
    "deleteSentItem": true,
    "deleteOriginal": true,
    "exportType": "eml"
  },
  "externalPromptConfig": {
    "promptType": "simple",
    "promptMsg": "You are sending this email to $$externalcount$$ external recipient(s). Are you sure you want to send it?",
    "useGALCheck": true,
    "useSmtpDomainCheck": true,
    "externalSmtpDomains": [],
    "internalSmtpDomains": ["yourcompany.com"],
    "resultHeader": "X-Enki-Result"
  }
}

Don't leave both domain lists empty

If useSmtpDomainCheck is true and both externalSmtpDomains and internalSmtpDomains are empty, the add-in treats every recipient as internal — the send-time warning won't fire at all. Always list at least your own internal domain(s) in internalSmtpDomains, as shown above.

Top-Level Options

Parameter	Type	Description
reportSpam	boolean	Turns the spam/phishing reporting button and context-menu entry on or off. Default: false.
promptSendToExternal	boolean	Turns the send-time warning for external recipients on or off. Default: false.
promptExternalUrl	boolean	Turns on link rewriting, so clicked links in external mail are checked before opening. Default: false.
spamReportConfig	object	Configures the spam/phishing reporting feature. See Spam Report Configuration.
spamReportRules	array	Per-message rules that override spamReportConfig based on the reported email's headers. See Spam Report Override Rules.
externalPromptConfig	object	Configures the send-time external-recipient warning. See External Prompt Configuration.
externalUrlPromptConfig	object	Configures the warning shown when a user clicks a link classified as external. See External URL Prompt Configuration.

Spam Report Configuration

Nested under spamReportConfig.

Parameter	Type	Description
submitTo	string	The email address reported messages are sent to. Required for reporting to work — if it's left unset, reported email has no recipient.
buttonText	string	The text shown on the ribbon reporting button.
contextMenuText	string	The text shown in the right-click context menu entry.
promptType	string	"simple" shows a plain confirmation dialog; any other value shows a more detailed report form.
promptMsg	string	The confirmation message shown when promptType is "simple".
completePrompt	string	The message shown after a report is sent successfully (and no override rule matched).
promptSend	boolean	If true, the composed report email is shown to the user for review before sending. If false, it's sent automatically. Default: false.
deleteSentItem	boolean	If true, and promptSend is false, the sent report is removed from the user's Sent Items folder. Default: true.
deleteOriginal	boolean	If true, and promptSend is false, the original reported email is removed from the user's mailbox. Default: true.
exportType	string	"eml" attaches the original message as a .eml file; any other value attaches it as .msg. Default: "eml".
emailSubject	string	The subject line for the report email. Supports the $$reason$$ and $$subject$$ placeholders — see Common Placeholders.
includeSmtpHeader	boolean	If true, the reported message's raw SMTP headers are included in the report body. Default: false.
includeSmtpHeaderAsAttachment	boolean	If true (and includeSmtpHeader is also true), the headers are attached as a text file instead of being inlined in the body. Default: false.
additionalInfoContent	string	Extra free-text content appended to the report. Supports the $$reason$$ placeholder.

A known naming inconsistency

Due to a defect in the current release, exportType must currently be entered exactly as shown here — exportType — but internally the add-in's JSON binding key is misspelled. If you've set exportType and reported messages still export as .eml when you expected .msg (or vice versa), contact Eventus support; this is being corrected in an upcoming release.

Spam Report Override Rules

spamReportRules is a list of rules, evaluated in the order they appear. The first matching rule overrides the corresponding fields from spamReportConfig for that report — useful for routing reports differently based on headers added by your mail security stack (for example, sending confirmed phishing-simulation hits to a different mailbox than general spam reports).

Parameter	Type	Description
type	string	The condition to evaluate: "headerexists" or "headernotexists".
value	string	The name of the header to check for.
submitTo	string	Overrides spamReportConfig.submitTo for this rule.
completePrompt	string	Overrides spamReportConfig.completePrompt for this rule.
emailSubject	string	Overrides spamReportConfig.emailSubject for this rule.
additionalInfoContent	string	Overrides spamReportConfig.additionalInfoContent for this rule.

External Prompt Configuration

Nested under externalPromptConfig. This controls the warning shown when a user is about to send email to recipients outside your organization.

Parameter	Type	Description
promptType	string	"simple" shows a plain confirmation dialog; any other value shows a more detailed prompt.
promptMsg	string	The message shown to the user. Supports the $$externalcount$$, $$internalcount$$, and $$totalcount$$ placeholders — see External Prompt Placeholders.
expandGroup	boolean	If true, distribution lists are expanded to their member addresses before checking whether recipients are internal or external. Default: true.
useGALCheck	boolean	If true, a recipient not found in your organization's Global Address List (GAL) is treated as external. Default: true.
useSmtpDomainCheck	boolean	If true, recipient domains are compared against externalSmtpDomains/internalSmtpDomains instead of (or alongside) the GAL check. Default: false.
externalSmtpDomains	array	Domains that should always count as external, even if other checks would say otherwise.
internalSmtpDomains	array	Domains that count as internal. Required if useSmtpDomainCheck is true — see the caution above.
resultHeader	string	The name of a custom header (for example, X-Enki-Result) written to the sent message recording whether it went to any external recipients — useful for downstream mail-flow rules or auditing.

External URL Prompt Configuration

Nested under externalUrlPromptConfig. This controls the warning shown when a user clicks a link that Enki classifies as external, when promptExternalUrl is enabled.

Parameter	Type	Description
promptType	string	"simple" shows a plain confirmation dialog; any other value shows a more detailed prompt.
promptMsg	string	The message shown before opening the link.
useDomainCheck	boolean	If true, the link's domain is compared against externalDomains/internalDomains to decide whether to prompt. Default: false.
externalDomains	array	Domains that should always be treated as external links.
internalDomains	array	Domains that should be treated as internal (trusted) links.

Common Placeholders

Available in spamReportConfig.emailSubject and spamReportConfig.additionalInfoContent (and their per-rule overrides in spamReportRules).

Placeholder	Description
$$subject$$	The subject line of the original reported email.
$$reason$$	The reason text entered or selected by the user when reporting.

External Prompt Placeholders

Available in externalPromptConfig.promptMsg.

Placeholder	Description
$$externalcount$$	The number of recipients classified as external.
$$internalcount$$	The number of recipients classified as internal.
$$totalcount$$	The total number of recipients.