Configuration

The configuration is stored in a file named MailGateway.Service.exe.config located in the installation folder. Since the installation folder is usually protected by Windows, administrator privileges are probably necessary to edit the file.

Mail Gateway supports multiple accounts which are unique combinations of an Exchange mailbox, a Lime CRM database and configuration options specific for the account. The support for multiple accounts makes it possible to monitor different mailboxes and import incoming messages into different databases if necessary.

The following is an example of a typical Mail Gateway configuration file used in a helpdesk solution:

<configuration>
  <configSections>
    <section name="lundalogik.dataaccess" type="Lundalogik.DataAccess.Configuration.DataAccessConfiguration, Lundalogik.DataAccess" />
    <section name="lundalogik.mailgateway" type="MailGateway.Configuration.MailGatewayConfigurationSection, Mailgateway.Core" />
  </configSections>
  <lundalogik.dataaccess>
    <databases>
      <database name="Lundalogik" accessMethod="WebService">
        <webServiceOptions binding="BasicHttp" address="http://localhost:1337/"/>
      </database>
    </databases>
  </lundalogik.dataaccess>
  <lundalogik.mailgateway>
    <accounts>
      <account>
        <mailbox emailAddress="support@lundalogik.com" userName="lime" password="A super secret password." useOauth2="true" clientId="x11x1111-example-key1-111x-11xx111x11x" tenant="22222xx2-example-key2-x2xx-222x222xxxxx"/>
        <outgoingEmail fromName="Lundalogik Support" fromAddress="support@lundalogik.com">
          <template type="FirstReply" filename="FirstReply.html" subject="Re: %%SUBJECT%% [%%HELPDESK.HELPDESKNO%%]">
            <subtable relationField="history">
              <fields>
                <field name="type" contents="179001" />
                <field name="note" contents="Sent automatic confirmation to customer by email." />
              </fields>
            </subtable>        
          </template>
        </outgoingEmail>
        <table name="helpdesk">          
          <fields>
            <field name="company" contents="%%COMPANY%%" updateExisting="false" />
            <field name="person" contents="%%PERSON%%" updateExisting="false" />
            <field name="title" contents="%%BODY%%" updateExisting="false" />
            <field name="helpdeskno" direction="Out" />
          </fields>
          <subtables>
            <subtable relationField="history">
              <fields>
                <field name="type" contents="179101" />
                <field name="note" contents="Received email from customer, saved as document." />
              </fields>
            </subtable>
            <subtable relationField="document">
              <fields>
                <field name="comment" contents="Email from customer received %%RECEIVEDATE%%" />
                <field name="type" contents="40601" />
                <field name="document" contents="%%MESSAGEFILE%%" />
              </fields>
            </subtable>            
          </subtables>
          <lookup field="helpdeskno" expression="\[(\d+)\]" searchLocation="Subject" />
        </table>
        <filters>
          <filter name="IgnoreInternalSenders" action="Ignore" input="%%FROMADDRESS%%" operator="MatchRegEx" expression=".*@lundalogik\.com$" />
        </filters>
      </account>
    </accounts>
  </lundalogik.mailgateway>
</configuration>

This very basic configuration above tells Mail Gateway to:

Lime CRM Web Service connection

The database and webServiceOptions elements specifies how to talk to the web service and where it is located.

Exchange mailbox

The mailbox element specfifies which mailbox to monitor for incoming messages.

Automatic replies

The outgoingEmail element specifies that an automatic templated reply is to be sent having a subject line consisting of the original subject line with the helpdesk ticket number appended. The following subtable element instructs the service to add a history note whenever that automatic reply is sent.

New helpdesk record

The table element specifies that a new record in the helpdesk table is to be created when a message arrives and to fill the fields of that records with parameters from the message.

New helpdesk history note

The first subtable element beneath the table element specifies that a history note saying that an email was received should be created and linked to the helpdesk record.

New helpdesk document

The second subtable element beneath the table element specifies that a document with the original messages should be created and linked to the helpdesk record.

Update existing records

The lookup element specifies that all incoming messages should have their the subject line scanned for string consisting of six digits in brackets (e.g. [123456]). If a match is found, a check is made whether a corresponding helpdesk record having that ticket number exists. If it does, that record is updated with new information and no new record is created.

Filter messages based on criteria

The filter element instructs the service to ignore all messages sent from addresses ending with @lundalogik.com

This section describes all XML elements and attributes available for configuring the connection to the LIME database via Lime CRM Web Service. Mail Gateway supports connections to different databases for different accounts.

Top element.

databases

Container element.

lundalogik.dataaccess

database

Defines the database name.

databases

• webServiceOptions

Defines options needed for connecting to Lime CRM Web Service.

database

This section describes all XML elements and attributes available for configuring the Mail Gateway service itself.

Top element.

• global
• accounts

Contains global settings that affect all accounts.

lundalogik.mailgateway

Contains one or more accounts that each correspond to a mailbox.

lundalogik.mailgateway

• account

This element contains all stand-alone configuration options for an account.

accounts

• mailbox
• profile
• errorHandling
• security
• table
• outgoingEmail
• senderIdentification
• filters

Configures the connection to Exchange Web Services, for example which mailbox to use with this account.

account

Note: when using Oauth2 authentication with Azure AD, the following attributes should be specified: emailAddress, userName, password, useOauth2, clientId, tenant.

Mailbox configuration options for when using MAPI for connecting to Exchange. Cannot be used with the mailbox element.

account

Options for configuring how Mail Gateway operates when an incoming email message cannot be imported for some reason.

account

This element contains options for configuring how Mail Gateway treats incoming messages in respect to security.

account

account

• fields
• subtables
• lookup

Container element.

• table
• template

• subtable

subtables

fields

Container element.

• table
• subtable

field

fields

table

account

template

outgoingEmail

subtable

Contains options for how Mail Gateway should attempt to associate company and/or person records with the sender of an incoming message. Matches on email, you must set a link-field with label “Email” for Mail Gateway to match against that field.

account

Container element. Note that filters are run in the order they are defined.

account

filter

Defines a message filter.

filters