Click below to download the imMail Zimlet for Zimbra 9.x

1. Single Sign-on Integration

Generating API KEY

In order to allow the integration with imMail, it will be necessary to generate an API KEY.

1.1 – Go to www.immail.ca;

1.2 – If the domain you want to configure already has an admin account on imMail, log in. If not, create a new account (usually the first account created for each domain is the administrator account).

1.3 – After logging in, click on the “Settings” menu in the upper right corner of the screen and select the “Manage Domain” option

1.4 –  Then select the API KEY option:

1.5 – Click on “Generate API Key”;

1.6 – Copy the created KEY API and store it in a safe place.

Setting up the Java extension

1.7 – Create an immail folder in /opt/zimbra/lib/ext

mkdir /opt/zimbra/lib/ext/immail

1.8 – Once you download the Zimlet file and unzip it into the server and copy the file “extension.jar” to /opt/zimbra/lib/ext/immail/extension.jar

cp extension.jar /opt/zimbra/lib/ext/immail/extension.jar

1.9 – Then create a text file config.properties in /opt/zimbra/lib/ext/immail/config.properties with the following contents:

immailURL=https://api.immail.ca
immailCreateTokenPath=/auth/token

1.10 – Create a file in /opt/zimbra/lib/ext/immail/config.domains.json

1.11 – Take the API Key generated in step 2.6 and you will type it in this file, as shown in the example below:

[
 {
    "domain": "companyxpto.com",
    "apiKey": "fbg3QZA9vZS9KCB62kb2E3mVWZu6Ez67"
 }
]

Each API Key is unique and exclusive to each domain. Remember that to generate each API Key you must log in to imMail in the admin account of the corresponding domain. It is possible to configure more than one domain. In the example below, 2 domains are configured. Remember that each JSON object starts with {and ends with}. If it is more than one object, it must be separated by “,”. Do not put “,” after the last one.

[
  {
    "domain": "companyxpto.com",
    "apiKey": "fbg3QZA9vZS9KCB62kb2E3mVWZu6Ez67"
  },
  {
    "domain": "companyxyz.com",
    "apiKey": "6SbkuQa9h6Te5N9yxJsGaPnWGFhXk2an"
  }
]

1.12 – Restart the service as shown below:

zmmailboxdctl restart

2. Basic Installation

At the end of this step, the Zimlet imMail must be installed, and a Tab (imMail) should be available into the  Chats Tab on Zimbra’s main menu. ( If you have configured the SSO Integration and the user logged in the Zimbra exists on imMail as well, the imMail dashboard will be shown as soon as you click on the tab. )

2.1 – Download the Zimlet file for Zimbra 9.x to the server and unzip it.

2.2 – Change to Zimbra user:

su zimbra

2.3 – Go to the unzipped folder:

2.4 – Run the following command to install the Classic Interface’s Zimlet:

zmzimletctl deploy ca_immail.zip

2.5 – Run the following command to install the Modern Interface’s Zimlet:

zmzimletctl deploy zimbra-zimlet-immail.zip

2.6 – Grant permission to imMail domains.

zmprov mc default +zimbraProxyAllowedDomains *.immail.ca

2.7 – Clear the Zimlet cache. After that, update the Zimlet.

zmprov flushCache zimlet

2.8 – Ensure that the Zimlet is active for users.
In the Zimbra admin console activate the Zimlet ca_immail

3. LDAP / AD integration and alternatives (optional)

To keep user data synchronized on the two platforms, Zimbra and imMail, the LDAP integration data must be configured in imMail. There are alternatives for this integration without using LDAP integration, for paid plans (spreadsheet file). Please contact support@immail.ca after signing up for a paid plan.

At the end of this step, all accounts retrieved by the LDAP query will be automatically created in imMail, not requiring the user (or domain admin) to create accounts in imMail.

3.1 – If the domain you want to set up already has an administrator account on imMail, log in. Otherwise, create a new account (the first account created for each domain will always be the administrator user);
3.2 – Click on the menu button at the top of the screen and choose the option “Manage Domain”;
3.3 – Go to the AD / LDAP integration tab and fill in the LDAP data. See the example below: