MTS Email Client — Admin Guide

Version: 1.0.0 Compatible with: SuiteCRM Community Edition Last Updated: 2026-03-14

Table of Contents

1. Overview
2. System Requirements
3. Installation
4. License Activation
5. Email Account Setup
6. Admin Settings
7. Uninstallation
8. Troubleshooting

Overview

MTS Email Client is a SuiteCRM module that replaces the default email interface with a modern, Gmail-style inbox. It provides a 3-panel layout (folder sidebar, email list, email reader), a floating compose modal, and deep CRM integration including record linking and quick-create.

The module ships in two license plans: - One-Time — single purchase, permanent use - Yearly — annual subscription

System Requirements

Note: PHP curl is required for license validation. The admin license page will display a warning if curl is not enabled.

Installation

Step 1 — Upload the Package

1. Log in to SuiteCRM as Administrator.
2. Navigate to Admin → Module Loader.
3. Click Choose File and select the ZIP file:
   • One-Time plan: MTS_Email_Client_1.0.0.zip
   • Yearly plan: MTS_Email_Client_Yearly_1.0.0.zip
4. Click Upload.
5. After the upload completes, click Install next to the uploaded package.
6. Review the pre-install check and click Commit.

Step 2 — Repair

After installation, run a Quick Repair to ensure all files and extensions are registered:

1. Navigate to Admin → Repair → Quick Repair and Rebuild.
2. Scroll down and click Execute.

Step 3 — Verify

Navigate to index.php?module=Emails&action=inbox to confirm the modern inbox loads correctly.

License Activation

The module requires an active license to function. Without a valid license, the inbox will be blocked for all users.

Activating Your License

1. Navigate to Admin → MTS Email Client → MTS Email Client License. Direct URL: index.php?module=MTS_EmailClient&action=license
2. Enter your License Key in the input field.
   • Your license key is available in your SuiteCRM Store account under My Purchases.
3. Click Validate.
4. A success indicator will appear once the key is verified.

License Validation Behavior

• Validation is performed against the SuiteCRM Store API.
• The validation result is cached locally and re-checked once per week.
• If the server cannot reach the API (e.g., no outbound internet), the last cached result is used.
• An admin-level error message with a link to the license page is shown if the license is invalid.
• Regular users see a generic "Contact your administrator" message.

License Plans

Each plan uses a different public key. Installing the wrong ZIP for your purchased plan will cause validation failure.

Email Account Setup

MTS Email Client works with SuiteCRM's built-in InboundEmail and OutboundEmail account records. No separate account configuration is required.

Setting Up an Inbound Email Account

1. Navigate to Admin → Email Settings → Inbound Email.
2. Click Add and fill in your IMAP server details:
   • Server address (e.g., imap.gmail.com)
   • Port (993 for SSL, 143 for STARTTLS)
   • Protocol: IMAP
   • SSL/TLS: Recommended
   • Username / Password
3. Save and test the connection.
4. The account will appear in the MTS Email Client inbox account selector automatically.

Setting Up an Outbound Email Account

1. Navigate to Admin → Email Settings → Outbound Email.
2. Configure the SMTP server for sending emails.
3. Users can also set up personal outbound accounts in User Profile → Email Settings.

Gmail / Google Workspace Notes

• Enable IMAP access in Gmail settings.
• If using 2-Factor Authentication, generate an App Password and use it instead of your Google account password.
• Google may require Less Secure App Access to be enabled for older configurations.

Microsoft 365 / Outlook Notes

• Use OAuth2 or App Password authentication as required by your tenant policy.
• Server: outlook.office365.com, Port: 993 (IMAP), 587 (SMTP)

Admin Settings

Navigate to Admin → MTS Email Client → MTS Email Client Settings, or directly at: index.php?module=MTS_EmailClient&action=admin

Level 1 — Compose Override (Global Toggle)

Controls whether the MTS floating compose modal replaces SuiteCRM's default "Compose Email" popup across CRM pages.

• When On: clicking "Compose Email" on any whitelisted CRM module page opens the MTS floating modal.
• When Off: SuiteCRM's default compose popup is used everywhere.

The compose modal is always enabled on the Home dashboard regardless of this setting.

Level 2 — Module Whitelist

Defines which CRM modules display the MTS compose modal. This setting is only effective when Level 1 is On.

Default enabled modules:

To modify the whitelist: 1. Check or uncheck the modules in the grid. 2. Use Select all / Deselect all links for bulk actions. 3. Click Save.

Uninstallation

1. Navigate to Admin → Module Loader → Installed Packages.
2. Find MTS Email Client and click Uninstall.
3. When prompted about database tables, choose:
   • Remove tables — deletes all module data permanently.
   • Keep tables — retains data for potential reinstallation.
4. Click Commit.
5. Run Quick Repair and Rebuild after uninstallation.

Troubleshooting

Inbox shows "License is no longer active"

• The license key is missing, expired, or invalid.
• Go to Admin → MTS Email Client License and re-enter your key.
• Ensure the server can reach https://store.suitecrm.com (outbound HTTPS on port 443).

No email accounts appear in the inbox

• Verify that at least one InboundEmail account is configured and its connection test passes.
• Check that the IMAP account is not marked as a Bounce Handling account (those are excluded from user display).

Folders do not load / IMAP error

• Confirm the IMAP credentials are correct and the connection test in Inbound Email settings passes.
• Check PHP imap extension is installed: php -m | grep imap.
• Some servers (e.g., Gmail) require enabling IMAP in their settings panel.

Compose modal does not appear on CRM pages

• Confirm Level 1 (Compose Override) is On in Admin Settings.
• Confirm the module is in the Level 2 whitelist.
• Run Quick Repair and Rebuild to regenerate extension cache.

Emails sent but not appearing in Sent folder

• Sent emails are stored in SuiteCRM's Email module.
• The "Sent (CRM)" folder shows emails sent via SuiteCRM.
• IMAP "Sent" folder shows emails stored on the mail server (only if the outbound account saves copies to IMAP).

Post-install script errors

• Ensure the post_install.php script executed correctly by checking the SuiteCRM logs at suitecrm.log.
• Re-run repair scripts: Admin → Repair → Quick Repair and Rebuild.

For further support, contact your MTS vendor or visit the SuiteCRM community forums.