Configuration

In Lime Admin

Settings are grouped into five sections under Mail Addin:

1. Install Outlook Add-in

Field	Purpose
Outlook Add-in Manifest	Base URL of the Lime CRM server (e.g. https://crm.example.com). Also provides the download link for the manifest.xml.

2. Choose a Limetype

Select which limetype is used when saving emails — for example, history. We recommend using a limetype that has a hasmany relation to Document, so attachments can be linked to the saved email record.

3. Map Email Fields

For each email property, pick which field on the chosen limetype should store it. Leave a mapping empty to skip that property.

Email property	Limetype field types
From (Sender)	Relation field pointing to your Person limetype (belongsto / hasone). The add-in looks up the Person by email address and links it automatically.
Received Date	datetime field. Stores the email's original timestamp — not the import date.
Subject	string field.
Body	text field. The field's card view must use the limebb-text-editor web component, otherwise HTML will not render correctly.
Headers	text or string field. Raw email headers — only needed for troubleshooting or compliance.

4 & 5. Auto-filled Fields

Set default values for any limetype property when a received or sent email is saved. Useful for setting a category, variant, or flag that powers automations. If the same property is also mapped under Map Email Fields, the mapped email value wins.

Follow-up Reminder

Toggle to let users optionally create a follow-up reminder in Lime CRM when saving an email.

In Application Config

JWT signing key — configure a JWT signing key for token signing in the application configuration.

<your-app>:
    secrets:
        limepkg_mail_addin:
            jwt_signing_key: <any-long-random-string>

In Server Config (on-premise only)

Redis for OAuth — configure a Redis URL for OAuth token storage in the server configuration. This is only required for on-premise installations.

plugins:
  limepkg_mail_addin:
    oauth:
      redis_url: redis://localhost:6379/1

The URL supports authentication (redis://user:password@host:port/db)