by Mien Trung Software

MTS Email Read Receipt is a SuiteCRM 8 plugin that shows you exactly when a recipient opens your outbound email. When your contact reads the message, SuiteCRM records the moment, displays a read status badge on the email, and sends you an instant in-app alert — so you know the right time to follow up. No guesswork, no chasing, just confident outreach.

Includes a 30 day guarantee
Try it Now

Admin Guide

MTS Email Read Receipt — Admin Guide


Administration Overview

Area Function
License Activate and manage the plugin license
Configuration Enable or disable tracking and notifications system-wide
MTS Email Receipt module View, search, and manage all tracking records
Emails module See read status badges on outgoing sent emails

License Management

The license page is the starting point for the plugin. Without a valid license, tracking does not run and the configuration page is not accessible.

To activate a license:

  1. Go to MTS Email Receipt → License from the module navigation bar.
  2. Paste your SugarOutfitters key into the license key field.
  3. Click Validate. A confirmation message confirms successful activation.

To change or renew a license:

  1. Go to MTS Email Receipt → License.
  2. Click Change Key to replace the existing key.
  3. Enter the new key and click Validate.

The plugin checks license validity in the background on a weekly schedule. You do not need to re-validate manually unless you replace or renew your key.


Configuration

The configuration page controls two system-wide settings. Both are enabled by default after installation.

To access configuration:

  1. Go to MTS Email Receipt → Configuration from the module navigation bar.
  2. Adjust the settings as needed.
  3. Click Save.

Settings

Setting Required Description
Enable Tracking Recommended Turns open tracking on or off for all outgoing emails across the system. When off, emails are sent normally but no tracking records are created and no read status badges appear.
Notify on Read Optional When on, the sender receives an in-app SuiteCRM alert the first time a recipient opens their email. Subsequent opens update the count but do not send another alert.

Changes take effect immediately on the next email sent from SuiteCRM.


MTS Email Receipt Module

The MTS Email Receipt module holds one record for each tracked outgoing email. Admins and users with appropriate permissions can view and search these records.

Record Fields

Field Description
Name Auto-generated label showing the date and time the email was sent
Sent To The email addresses the message was delivered to
Date Sent The date and time the email left SuiteCRM
First Opened The date and time the email was first opened by a recipient
Open Count The total number of times the email was opened
Last IP The network address recorded on the most recent open
Last User Agent The browser or mail client information from the most recent open
Assigned To The SuiteCRM user who sent the email

Searching and Filtering

Use the search bar at the top of the MTS Email Receipt list to find records by recipient address, date range, or assigned user. Standard SuiteCRM list view controls apply — sort by column, paginate through results, and export to CSV as needed.

Access Control

Receipt records follow SuiteCRM's standard permissions. Users see records assigned to them. Admins and users with the appropriate role can see all records. Security Groups are supported if your SuiteCRM installation uses them.


Backup and Restore

Before upgrading or reinstalling the plugin:

  1. Go to Admin → Studio and note any custom field additions you have made to the MTS Email Receipt module (if any).
  2. Export the MTS Email Receipt list to CSV from the module list view as a data backup.

After reinstalling:

  1. Go to Admin → Repair → Quick Repair and Rebuild if tracking records or badges are not visible.
  2. Re-validate your license at MTS Email Receipt → License if the key was not retained.

Maintenance

  • Run Admin → Repair → Quick Repair and Rebuild after any SuiteCRM upgrade to ensure tracking remains active.
  • Review receipt records periodically and delete old records you no longer need — use the list view's bulk-select and delete controls.
  • If your SuiteCRM site URL changes (e.g. a domain migration), send a test email and confirm the tracking marker still loads correctly. The marker URL is built from the site URL configured in Admin → System Settings → Site URL.

Common Troubleshooting

Read badges have disappeared from the Emails module

Run Admin → Repair → Quick Repair and Rebuild. This rebuilds the read status field in the Emails module. Reload the Emails list after the repair completes.

Receipt records are being created but First Opened is never populated

Your organisation's outgoing email server may be stripping images. Check whether image loading is blocked on the email server. Also check whether recipients use mail clients with images disabled by default (common in corporate environments).

Users are not receiving in-app notifications on first open

Confirm that Notify on Read is turned on in the configuration. Also confirm that the user who sent the email is still active and their SuiteCRM account is in good standing.

The Configuration page is not accessible — it redirects to the License page

The license key has expired or is no longer valid. Renew your subscription and re-validate the key at MTS Email Receipt → License before accessing configuration.

A receipt record exists but the linked email cannot be found

The email record may have been deleted in SuiteCRM after the receipt was created. The receipt record remains as a historical tracking log. The tracking data (open count, dates) is still accurate.


  • Website: mientrungsoft.com
  • Email: anhnhatuit@gmail.com
  • WhatsApp: +84973131884
Saving Comment Saving Comment...