The Maillog module for OpenMage
Contents (v5.9.0)
Don't forget that the present documentation is only about the latest version of the module.
Don't forget to read this page entirely.
🌟🌟🌟🌟🌟 by Jérôme,
on 01/04/2020 This module isn't premium, isn't ultimate, isn't pro, it doesn't contain a spyware or a nice ad, and it won't increase by 165% your ROI. It's just better than anything else you've seen anywhere else. It's a revolution!
Module presentation
Description
This module allows:
- to show sent emails history
- to import unsubcribed and invalid email addresses in OpenMage
- to synchronize customers data from OpenMage to your System (Emarsys or Mautic, multithreaded)
- to send emails in background (without affecting the loading time of the page)
- to send the correct email for newsletter emails when sending from the backend
- to add support for comparison operators to conditions and the foreach loop in emails
- to get a daily, weekly or monthly report about the state of the sending of emails, synchronizations and imports
The report is sent by email during the night according to the configuration.
The queue is deactivated when the module is active and every email sent with the class Zend_Mail is "captured" by the module.
Access and configuration
Configuration available in System » Configuration » Tools » Transactional emails and in Customers synchronization.
Available in Tools » Transactional emails and in Customers synchronization.
Configuration also available in System » Configuration » Customers » Newsletter.
Also available in the Transactional emails tab of orders and customers.
History lifetime
The lifetime is easily configurable via a number of days (or months or years).
For each line:
- the first drop-down list corresponds to the lifetime of the content of the email and any attachments (if it is deleted, we keep the rest)
- the second is the lifetime of the email (if it is deleted, there is nothing left)
- the first color box corresponds to the background color of the header (when displayed online)
- the second is the text color of the header
...
Security
...
Compatible with OpenFileEditor
When OpenFileEditor browser extension is installed, when a PHP error trace is displayed, file paths can be clicked, to open them in your preferred file editor.
Installation and uninstallation
Nothing simpler with composer (or by decompressing the module archive).
To get the key, don't stop reading :) ...
Then apply: openmage.diff
To allow emojis in subject and content of emails, in the local.xml file, you must use SET NAMES utf8mb4 for initStatements (see OpenMage#430).
Finally, do not forget to configure crontab to run the maillog.sh file every minutes.
crontab* * * * * www-data bash /path/to/maillog.sh
For uninstallation, having uninstalled the module, removed the changes in lib/Zend/Mail/Transport/Sendmail.php and lib/Varien/Filter/Template.php, and stop crontab for maillog.sh, all that remains is to erase the configuration and data:
sqlDELETE FROM core_config_data WHERE path LIKE "maillog%";
DELETE FROM core_config_data WHERE path LIKE "crontab/jobs/maillog_%";
DELETE FROM core_config_data WHERE path LIKE "newsletter/%/%send";
DELETE FROM core_resource WHERE code = "maillog_setup";
DELETE FROM eav_attribute WHERE attribute_code = "is_bounce";
DROP TABLE IF EXISTS luigifab_maillog;
DROP TABLE IF EXISTS luigifab_maillog_sync;
DROP TABLE IF EXISTS luigifab_maillog_bounce;
Emails and wysiwyg directives
...
Emails configuration
Variables list:
#uniqid##mailid#xyz##online#/#online#storeId##readimg#
...
Synchronization configuration
Synchronization allow to synchronize customer data from OpenMage to your System.
It is performed every minutes by cron job on the following events (whether from the backend or from the frontend):
- when customer login,
- when saving or deleting a customer,
- when saving or deleting a subscriber,
- when saving a shipping or a billing address of a customer,
- when invoicing an order.
...
Module download
Installation with composer: composer require luigifab/openmage-maillog
Download of the latest version: openmage-maillog-5.9.0.tar.gz
See also: github - composer - geany - phpstorm
- Current version: 5.9.0 (01/01/2024)
- Compatibility: OpenMage 19.x / 20.x / 21.x, PHP 7.2 / 7.3 / 7.4 / 8.0 / 8.1 / 8.2 / 8.3 (with exec)
- Client compatibility: Firefox 36+, Chrome 32+, Opera 19+, Edge 16+, Safari 9+
- Translations: English (en), French (fr-FR/fr-CA), German (de), Italian (it), Portuguese (pt-PT/pt-BR), Spanish (es) / Chinese (zh), Czech (cs), Dutch (nl), Greek (el), Hungarian (hu), Japanese (ja), Polish (pl), Romanian (ro), Russian (ru), Slovak (sk), Turkish (tr), Ukrainian (uk)
- License: GNU GPL 2.0+
- Read absolutely: the README file
- 5.9.0
- Tested with Firefox 36/114, Chrome 32/109, Edge 109, Opera 19/95 on OpenMage 21.3.0 with PHP 7.2 - 8.3 and MariaDB 10.11.
If you like this module, take some of your time to improve the translations.