Contacts Export Wizard Configuration File

Document created by user.oxriBaJeN4 Employee on Apr 25, 2016Last modified by user.QZGHBD9VWW on Jan 18, 2017
Version 7Show Document
  • View in full screen mode

The Contacts Export Wizard uses a .Net Application Configuration file, commonly referred to as the "app.config" file, to hold various override switches. This configuration file is an XML file, that can be changed using any text editor (e.g. Notepad).

Before editing the app.config file, we recommend you create a backup. This can be useful if the application fails to load due to a misconfiguration.

The "app.config" file always resides in the same directory as the application's main executable, and shares the same name as the executable with a .config extension. For example:

 

          Mimecast.Contacts.Export.exe.config

 

Commenting Out Settings

 

By default, the application ships with a config file that contains settings that have been commented out. You can enable any of these settings by removing the XML comments. For example, the Ignore Invalid SSL Certificates switch is disabled by default with the line commented out in the app.config file.

 

   <!--<add key="Network.Security.IgnoreCertificateErrors" value="true"/>-->

 

If you need to allow the use of a self-signed certificate, remove the comments to leave the line:

 

   <add key="Network.Security.IgnoreCertificateErrors" value="true"/>

 

Log Files

 

The Contacts Export Wizard does not produce logs by default, but these can be enabled to help when troubleshooting. There are two settings that control this:

 

SettingDescription

<add key="Log.Enable" value="true"/>

Turns logging on or off. A value of "true" enables logging. A value of "false" disables it. If log files are enabled, a new log file is created in the same directory as the executable, each time the application is run.

<add key="Log.Level" value="info"/>

Controls the volume of output. The possible values are:

ValueDescription

error

This value dumps exception details including stack traces.
warnThis value writes out possible issues that could cause unexpected behavior
infoThis value emits only key events in the applications life cycle. This is the default value.
debugThis value outputs all log lines.

These levels are inclusive, meaning lower values include all higher values. For example "debug" includes "info", "warn", and "error". If you are experiencing issues, setting a value of `debug` will be your best option.

 

Log file names have the naming convention:

 

          <appname>.YYYYMMDDHHMMSS.log

 

where:

    • <appname> is the name of the Contacts Export Wizard application executable.
    • YYYYMMDD is the date (year, month, and date) the wizard started.
    • HHMMSS is the time (hour, minute, and second) the wizard started.

 

For example a log file called Mimecast.Contacts.Export.20160403084707.log:

    • Had an executable of Mimecast.Contacts.Export.exe.
    • Was started on 4th April 2016
    • Was started at 08.47.07seconds

 

Mailbox Access

 

When connecting to multiple mailboxes, the authenticated account will need access permissions to read the contents of the Inbox, Sent Items, and Contacts folders. More details can be found on Microsoft's MSDN Site.

 

There are three supported methods of access:

 

Access MethodAdditional Access Required
Own mailboxThe connecting account is accessing it's own mailbox. No additional permissions are required.
ImpersonationThe connecting account requires impersonation rights to the target mailbox. This is the recommended approach.
Delegate Access

The connecting account requires delegate access to the folders.

The Sent Items folder is not supported.

 

By default, the application assumes Impersonation access when connecting to target mailboxes that are not it's own. You may override this adding the Exchange.Mailbox.Access key to the configuration file as follows:

 

     <add key="Exchange.Mailbox.Access" value="xxxxxxxx"/>

 

where xxxxxxxx is either:

    • Impersonation
    • DelegatedAccess

Exchange Versions

 

If you having issues with Exchange Web Services (EWS) calls against your Exchange server, you could try to resolve this by specifying the exact version of your Client Access Server (CAS) server. By default, it is assumed the server version is anything from Exchange 20017 SP1 or later.

 

To override this, using the Exchange.Mailbox.Access key ad follows:

 

     <add key="Exchange.Version" value="xxxxxxxx"/>

 

where xxxxxxxx is either:

    • Exchange2007_SP1
    • Exchange2010
    • Exchange2010_SP1
    • Exchange2010_SP2
    • Exchange2013
    • Exchange2013_SP1

 

SSL Certificates

 

For security reasons, the Contacts Export Wizard application rejects any invalid SSL certificates presented by the Exchange CAS. This includes internal self signed certificates. If you are testing the app against an internal staging Exchange server that does not have a valid SSL certificate or has a self-signed certificate, you can instruct the app to ignore these certificate errors by overriding the `Network.Security.IgnoreCertificateErrors` key.

 

   <add key="Network.Security.IgnoreCertificateErrors" value="xxxx"/>

 

where xxxx is a boolean flag with the values:

  • true
  • false

 

See Also...

 

Attachments

    Outcomes