MTS Email Client — Installation Guide

Version: 1.0.0 Last Updated: 2026-03-14

Overview

This guide covers the complete installation process for MTS Email Client on a SuiteCRM Community Edition instance — from pre-install checks through to verifying a working inbox.

Estimated time: 10–15 minutes

Before You Begin

Pre-Installation Checklist

Confirm the following before proceeding:

• [ ] You are logged in to SuiteCRM as an Administrator
• [ ] SuiteCRM version is 7.12 or higher
• [ ] PHP version is 7.4 or higher
• [ ] PHP extensions curl, imap, zip, and openssl are enabled
• [ ] You have the correct ZIP file for your license plan:
  • One-Time: MTS_Email_Client_1.0.0.zip
  • Yearly: MTS_Email_Client_Yearly_1.0.0.zip
• [ ] You have your license key from your SuiteCRM Store account
• [ ] You have IMAP credentials for at least one email account to test with

Verify PHP Extensions

You can check which PHP extensions are available by running this command on your server:

php -m | grep -E "curl|imap|zip|openssl"

Expected output:

curl
imap
openssl
zip

If any extension is missing, enable it in your php.ini and restart your web server before continuing.

Step 1 — Upload the Package

1. Log in to SuiteCRM as Administrator.
2. Navigate to Admin (top-right menu) → Module Loader.
3. In the Upload Package section, click Choose File.
4. Select the appropriate ZIP file:
   • MTS_Email_Client_1.0.0.zip — One-Time plan
   • MTS_Email_Client_Yearly_1.0.0.zip — Yearly plan
5. Click Upload.

Wait for the upload to complete. The package will appear in the Uploaded Packages list below.

Step 2 — Install the Package

1. In the Uploaded Packages list, locate MTS Email Client.
2. Click Install.
3. The pre-install check page will display. Review any warnings.
4. Click Commit to begin installation.

SuiteCRM will copy module files, register extensions, and run the post-install script. This typically takes 10–30 seconds.

Do not navigate away from the page during installation.

Step 3 — Run Quick Repair

After installation completes, rebuild SuiteCRM's extension cache:

1. Navigate to Admin → Repair → Quick Repair and Rebuild.
2. Scroll to the bottom of the page and click Execute.
3. Wait for the repair to finish (the page will show "Done" or similar output).

This step is required to register the module's language files, menus, and extensions properly.

Step 4 — Activate Your License

The module will not function until a valid license key is entered.

1. Navigate to Admin → MTS Email Client → MTS Email Client License. Or go directly to: index.php?module=MTS_EmailClient&action=license
2. Enter your License Key in the input field.
   • Your key is available in your SuiteCRM Store account under My Account → My Purchases → MTS Email Client.
3. Click Validate.
4. A green Validated indicator confirms the license is active.

The server must have outbound HTTPS access (port 443) to store.suitecrm.com for validation to succeed.

Step 5 — Configure an Email Account

MTS Email Client reads from SuiteCRM's standard InboundEmail accounts. At least one account must be configured.

Add an Inbound Email Account

1. Navigate to Admin → Email Settings → Inbound Email.
2. Click Add to create a new account.
3. Fill in your IMAP server details:

4. Click Test Settings to verify the connection.
5. Click Save if the test passes.

Add an Outbound Email Account (for Sending)

1. Navigate to Admin → Email Settings → Outbound Email.
2. Click Add and configure your SMTP server.
3. Test and save.

Users can also configure personal outbound accounts under User Profile → Email Settings.

Step 6 — Verify the Installation

1. Navigate to the modern inbox: index.php?module=Emails&action=inbox
2. Confirm the 3-panel layout loads (sidebar, email list, reader).
3. Select your email account from the account selector in the sidebar.
4. Confirm the folder tree and email list load correctly.

Step 7 — Configure Admin Settings (Optional)

Customize compose modal behavior via Admin → MTS Email Client Settings: index.php?module=MTS_EmailClient&action=admin

• Level 1 — Enable or disable the compose modal on CRM pages globally.
• Level 2 — Select which CRM modules display the MTS compose modal.

See the Admin Guide for full details on these settings.

Upgrading from a Previous Version

If you are upgrading from a pre-release or beta build, uninstall the old version first before installing 1.0.0.

Upgrade Steps

1. Navigate to Admin → Module Loader → Installed Packages.
2. Click Uninstall next to the old MTS Email Client version.
3. When prompted about tables, select Keep tables to preserve settings.
4. Run Quick Repair and Rebuild.
5. Follow Steps 1–6 above to install the new version.
6. Re-enter and validate your license key (Step 4).

Uninstallation

To remove the module:

1. Navigate to Admin → Module Loader → Installed Packages.
2. Click Uninstall next to MTS Email Client.
3. Choose whether to Remove tables (deletes all data) or Keep tables.
4. Click Commit.
5. Run Quick Repair and Rebuild after uninstallation completes.

Troubleshooting Installation

Upload fails or times out

• Increase PHP limits in php.ini: ini upload_max_filesize = 50M post_max_size = 50M max_execution_time = 300 memory_limit = 256M
• Restart your web server after changing php.ini.

"Could not install" error during commit

• Check suitecrm.log for the specific error.
• Ensure the modules/ and custom/ directories are writable by the web server user: bash chmod -R 755 modules/ custom/ chown -R www-data:www-data modules/ custom/

License validation fails

• Confirm the server can reach https://store.suitecrm.com: bash curl -I https://store.suitecrm.com
• Check that curl is enabled in PHP: php -m | grep curl.
• Ensure you are using the correct ZIP for your purchased plan (One-Time vs Yearly).

Inbox loads but shows no accounts

• At least one InboundEmail account must be configured and have a passing connection test.
• Navigate to Admin → Email Settings → Inbound Email and verify.

Module does not appear in Admin menu after install

• Run Admin → Repair → Quick Repair and Rebuild again.
• Clear your browser cache and reload.

Installation complete. See the User Guide to get started using the inbox.