Installation
Requirements
Section titled “Requirements”- CS-Cart or CS-Cart Multi-Vendor 4.17.2 – 4.21.x.
- PHP 7.2.5 – 8.3 (as supported by your CS-Cart version) with the zlib extension (standard; without it messages are stored uncompressed).
- A working mail setup in Settings > E-mails (PHP mail(), sendmail or SMTP). The add-on uses these settings; it does not replace them.
- For the cron sending mode and retries: a cron job (see below).
Install
Section titled “Install”- Go to Add-ons > Manage add-ons, click the gear icon and choose Manual installation.
- Upload
kv_email_log-1.0.0.zipand click Upload & install. - Enter your license key under Settings > License (or the Marketplace license number in Add-ons > Manage).
- Open Administration > E-mail log. From now on every e-mail is logged.
The default settings are safe for any store: e-mails are sent directly as before, every message is stored, failed e-mails are retried, entries are kept for 90 days and messages for 30 days.
Privileges
Section titled “Privileges”The add-on adds two privileges in the Administration group:
| Privilege | Allows |
|---|---|
| View the e-mail log | Log, entry details, preview, CSV export, E-mails tabs on orders and customers |
| Manage the e-mail log | Resend, cancel and delete entries, send the queue, mute templates, test e-mails, privacy tools |
Both are given to administrator user groups with full access on install. Restricted administrators need them added in Customers > User groups.
Cron job
Section titled “Cron job”Needed for the By cron sending mode and for retries of failed e-mails. The exact command and URL are shown in the settings (Background sending > Cron job). Run it every minute:
* * * * * php /home/yourstore/public_html/admin.php --dispatch=kv_email_log.cronOr call the URL https://yourstore.com/admin.php?dispatch=kv_email_log.cron&cron_password=CRON_PASSWORD every minute (the password is the one in Settings > Security settings). The same job deletes old entries once a day.
Without a cron job, use Send queued now on the log page; the log warns when e-mails have waited for more than 15 minutes.
Upgrading
Section titled “Upgrading”Upload the new package the same way (or use the Upgrade Center). Settings, the log and the queue are kept.
Uninstalling
Section titled “Uninstalling”Before the add-on is disabled or uninstalled, e-mails still waiting in the queue are sent (for up to 20 seconds; anything left is reported). Uninstalling removes the log tables, the stored messages and attachment copies, the settings, the privileges and the language variables.