Installation Instructions¶
Preparations¶
Do these preparations well in time before the installation is planned.
- Check that the requirements are met.
- Make sure to clean up the inbox folder of all the shared (delegated) email accounts you are adding to this integration. Every email in the inbox folder of a shared account, being marked as
unseen
(i.e.new
), will be imported to Lime CRM when the integration is enabled for that account. Before enabling the integration, move unwanted emails away from the inbox folder. - Make sure to familiarise yourself with the key concepts of the integration.
- If Lime CRM on-premise: Follow internal Lime Technologies' documentation for retrieving a valid license key to EmailEngine.
Installation¶
This is your checklist during the installation.
- Add limepkg-email as a dependency to your solution.
- Build and deploy your solution.
- In Lime Admin, go to the Setup page in the Email Integration settings and follow the installation instructions.
- Configure the add-on..
- If Lime CRM on-premise: Follow internal Lime Technologies' documentation for adding a license key in EmailEngine.
Database Structure¶
The following relations are created during the installation process:
- Relation between
conversation
table andhelpdesk
table (conversation parent). - Relation between
follower
table andcoworker
table (follower parent). - Relation between
follower
table andperson
table (follower parent).
If this is not wanted or if you want other parents (for example a company
follower parent), manual hand-laying in LISA is required.
emailengine@lime User¶
The integration user emailengine@lime
was created during the installation process. The webhook endpoint for the email integration implements impersonation for this specific user. Also, the scheduled task that handles unprocessed emails runs as this user. This user is added to the Administrators group and must not be a member of any other groups.