Current version: v1.9.0
...
The module synchronizes customer data, order data and shopping cart information between Magento and Maileon. Magento is the primary system, which means that the customer information in Magento is considered the main information and changes to that data are synchronized with Magento. Conversely, only certain information is synchronized: the DOI confirmation and unsubscription. For order details and cart abandonments, this information is sent to Maileon as transactions (events) and can be used either to analyze data using contact filters or to activate a trigger mailing. All functions can be set via a configuration panel in Magento.
Install the Module
Below version 1.0.8
The first step is to copy the Maileon directory into the /app/code directory of the Magento installation. If the app directory doesn't already contain a code subdirectory please create it. After this the module must be enabled using the following steps:
...
php bin/magento setup:upgrade
Configuration in Magento
The configuration can be found under “Stores” “Configuration” and, since version 1.8, can be set on Storeview level. This means, that for each Storeview, you can select an own API key, to use different Maileon accounts or you can select different DOI mail keys to send out DOIs in e.g. different languages.
...
General Settings
...
Maileon Api Key: The API key associated with the Maileon account you wish to use.
Print CURL Debug Data: Enabling this will log show Maileon API responses. Useful for debugging. Not to be used in a live environment!
Subscriber Settings
Figure 3: Subscriber settings
Active: This enables the newsletter subscriber module. This module synchronizes new subscriptions to Maileon.
Initial Permission: The initial permission level to set for new Maileon subscribers.
None: No permission. This is most likely what is required, e.g. in Germany.
Single Opt-in: Consent only given once, e.g. by entering the email address on the registration form. This does not guarantee that the subscriber is indeed identical with the email account owner.
Confirmed Opt-in: A confirmation mail about the registration is sent to the provided email address, but it does not contain a confirmation link. This method is frequently abused by spammers. The recipient will have to actively revoke consent in order not to receive any advertising emails. This method is not really legal in Germany and should not be used.
Double Opt-in: Set double-opt-in in Maileon, e.g. if such a permission has already been gathered externally.
Double Opt-in Plus: Double-opt-in including consent to single user tracking.
DOI Process: A confirmation email including a “confirmation link” is sent to the provided email address. The subscription will not be valid until the recipient clicks this link. Thus it is ensured that the recipient is identical to the mailbox owner and really wishes to receive your emailings (the recipient cannot click the confirmation link without having signed in to her or his mailbox). Double Opt-in is the only subscription method we can recommend. Please note that XQ can only provide general information but no official legal counselling. Please contact your lawyer in the case of legal questions on this topic.
DOI+ Process: Requires option “DOI Process”. A DOI+ permission will be registered after the user clicks the DOI confirmation link in the DOI mail.
...
Doi Mailing ID: If the permission above is set to DOI or DOI-Plus the newsletter subscriber will be sent a confirmation mailing using Maileon. This field can be used to customize which DOI mailing will be sent from Maileon. Leaving it empty means that the default DOI confirmation will be sent. (A default DOI confirmation mailing must be set in Maileon in order for this to work.)
Unsubscribe Hook Token: This token is used to synchronize Maileon unsubscribers back to Magento. This field must be a unique string. (Think of it as a password.) The hook setup will be detailed later.
Doi Hook Token: This token is used to synchronize Maileon DOI confirmations back to Magento. If set the Magento subscriber state will match the Maileon subscription state of each customer. This field must be a unique string. (Think of it as a password.) The hook setup will be detailed later.
At storeview all emails should be unsubscribedUnsubscribe All Emails: Since Magento 2.4, an email can be registered multiple times with Magento (one time for each storeview). When Maileon reports back unsubscribers to Magento it passes along the storeview ID but if that data gets deleted or is not added in the webhook configuration, Magento does not know from which storeview to unsubscribe the contact of. This option allows to unsubscribe all contacts with a given email address (from all storeviews) if ambiguous or if required (e.g. by law).
Disable confirmation request email: Used to disable the built-in Magento DOI confirmation email.
Disable success email: Used to disable the built-in Magento DOI success email.
Disable unsubscription email: Used to disable the built-in Magento unsubscriber email.
Order Confirmation Settings
...
Active: This enables the order confirmation module. This module synchronizes order events to Maileon. Each order creates two types of transactions: magento_orders and magento_orders_extended. The transaction magento_orders contains one event for each order. The transaction magento_orders_extended contains one event per line item in the order.
...
Figure 5: Maileon Order-Confirmation-Transactiontype
...
Figure 6: Extended Maileon Order-Confirmation-Transactiontype
Fallback permission: Maileon will create a contact for each transaction to be able to provide access to e.g. online versions of the newsletter, later on. Often there is a possibility to subscribe to the newsletter during an order process. In this case, if DOI or DOI+ is selected as newsletter permission, the customer will also get a DOI mail.
...
Enable separate permsission for buyers: todo
Buyers permission: todo
Abandoned Cart Settings
Figure 7: Shopping Cart Abandonnment Mail Settings
...
Figure 8: Transactiontype for Cart Abandonnments
Configuring Custom Forms
In order to submit other standard or custom data to Maileon, the following scheme must be used:
...
Example: custom_MySpecialField
Enhancing Transactional Data
In some cases, it is required to add custom data transactions. E.g. if you use a plugin, which allows customizing products with names, custom images, etc., and the image shall be displayed in the order confirmation mail, you need to pass this URL to Maileon. Or this case, the plugin provides a simple way to add data to the transactions by overriding class “Maileon\SyncPlugin\Helper\External\Data” from an external plugin.
...
Figure 9: Additional information attached to a transaction
Webhook Settings in Maileon
Changed parameters in version 1.8:
Since Magento 2.4, an email can be added as newsletter subscriber for each storeview, thus, the email can exist multiple times in the Magento newsletter module. As of version 1.8 of the plugin, configuration is based on storeview level, thus, an email can be added to different Maileon newsletter accounts based on its origin. Thus, when Maileon reports back a DOI confirmation or unsubscription, it needs to identify the correct storeview for a given contact. This is done by adding a new parameter “storeview_id”.
...
Figure 11: Webhook Settings for DOI-Confirmations
Changelog
30.08.2022 – v 1.8.9
Added payment method ID and name to order transactions
...