Exchange On Premise Engine Setup

Created by Paul Mendoza, Modified on Thu, 07 Sep 2023 at 09:39 AM by Paul Mendoza

Create a Virtual Machine


See the Virtual Machine Sizing Guide.


In Windows Explorer turn on the visibility of file extensions.


Download and Install

Download the latest version of the On Premise Email Mining Engine zip file from the file share.


  1. Right click on the Zip file and click Extract to…
    1. Select the location C:\sigparser
    2. Click Next
    3. Wait for the extract to finish
  2. Go to c:\sigparser
  3. Copy the appsettings-template - exchange.json file from C:\sigparser\EmailFetcher folder and paste it to C:\sigparser folder. Then rename the file to appsettings.json
  4. Open the new appsettings.json file for editing. We’ll put all our configuration into this file. Then later we’ll copy this file to different locations for each of the apps. 
  5. In C:\sigparser create a text file named allow.txt
    1. If you want to allow only specific domains to be mined then put each domain name on a different line. 
    2. If you want all domains to be mined then put an asterisk (*) only in the file. 
  6. In C:\sigparser create a file called deny.txt
    1. On each line put any email domains SigParser shouldn’t process if all the people on an email have those domains. This should generally be your company domain names and maybe your HR company. 
  7. In Windows search for Environment Variables and add the following AWS environment variables
    1. SigParserLicenseKey with the license key from SigParser
    2. AWS_ACCESS_KEY_ID = Access key with permission to write to Cloudwatch logs.
    3. AWS_SECRET_ACCESS_KEY = Access key secret for writing to Cloudwatch logs. 
  8. Rename the file c:\sigparser\EmailFetcher\log4net-template.config file to log4net.config
    1. Open c:\sigparser\EmailFetcher\log4net.config
      1. Change the LogGroup and Region setting to the value provided by SigParser IT
      2. Save the file
    2. Copy c:\sigparser\log4net.config to c:\sigparser\EmailFetcher\

Mailbox Setup

  1. Setup a delegated mailbox. See this article.
  2. Create the file c:/sigparser/mailboxes.txt
    1. Add email mailbox to be monitored to this file.

Tip: We suggest setting up a schedule task which uses Powershell to look at a group and populates the mailboxes.txt file every couple hours.

Secret Store

If you use the secret store you can use these options.

  1. Copy the C:\sigparser\EmailFetcher\secrets-template.json file and paste it to C:\sigparser folder. Then rename the file to secrets.json
  2. Set the following entries:
    1. ServerUrl - the server URL of the Exchange server
      1. https://help.karbonhq.com/en/articles/1524542-how-do-i-find-my-exchange-server-address
      2. The URL often begins with “https://” and ends in “/ews/exchange.asmx”
    2. EmailAddress - the delegated account’s email address. You'll set this up next but this is where it goes.
    3. Password - the delegated account’s password
    4. SigParserApiToken - Create an account at https://app.sigparser.com. Generate an API token. See this article. 

Here is an example secrets.json file:


{
  "ServerUrl": "EXCHANGE_SERVER_URL/EWS/Exchange.asmx", 
  "EmailAddress": "USERNAME",
  "Password": "PASSWORD",
  "SigParserApiToken":  "GENERATE_THIS_KEY_AT_SIGPARSER.COM"
}



Exchange Specific Configuration Options

These are the settings that either go in the appsettings.json file or environment variables.


  • ServerUrl - Secret - URL of the Exchange server. Example: https://west.exch070.serverdata.net/EWS/Exchange.asmx
  • EmailAddress or UserName or ExchangeUsername - Secret - Email address of the impersonation mailbox or the mailbox that has access to the other mailboxes. Example: sigparser-impersonation@example.com. ExchangeUsername doesn't work via the secrets store.
  • Password or ExchangePassword - Secret - Password for the mailbox we're signing in as. ExchangePassword doesn't work via the Secrets store.
  • emailprovider - Setting - Should always be set to "Exchange"
  • exchange_use_impersonation - Setting - Is the mailbox using impersonation?



Next Steps:



Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select atleast one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article