Installation Instructions

Preparations

• Check that the requirements are met.

Warning

If the customer is currently using the inbox(es) with Mail Gateway, be warned that Lime Inbox will fetch and remove mails from the inbox ahead of MGW. Use a test-inbox for development, not the real one(s). Configuring the inboxes as inactive in step 3 (Configuration) would also work.

Installation

Adding this addon to your solution is straight forward. Make sure you complete all the steps in every section below

1. Install package

Run poetry add limepkg-ms-inbox in your solution folder

2. Configure user in any of the following ways:

• Add an addon specific user called [email protected] with admin rights.

• If you want another user to be used you can add an environment variable called LIMEPKG_MS_INBOX_USERNAME.

Info

If you develop locally you can set it in your .env file

LIMEPKG_MS_INBOX_USERNAME=<whatever-username-u-want>

3. Go to configuration and configure your clients

See configuration next.

4. (Optional) Helpdesk behaviour

If planning to use Lime Inbox for helpdesk tickets, please see Behaviours for logic and fields required.