...
Oxid eShop version | Module version | Download | Last Update |
---|---|---|---|
Oxid eShop 6.x.x | Maileon Oxid Module 1.3.x | 2025.02.24 | |
Oxid eShop 7.x.x | Maileon Oxid Module 1.4.x | 2024.05.21 |
Installation
The module is using contact preferences in Maileon, so please check the contact preferences is turned on, at your Maileon account.
...
The plugin can be installed from the command line. The installation steps:
...
With Oxid Enterprise Edition, sub shop management is also possible. In this case you can choose on the top left of the admin page which sub shop settings you want to see. This allows you to set different configuration settings per sub shop.
...
Settings page
...
Connection settings
Maileon API Key
The API Key can be created and viewed in the Maileon account under "Settings" → "API Keys" and ensures the connection to the account. Common errors:
Validity period exceeded
Key was deactivated in Maileon
Characters were truncated at the beginning or end
Synchronisation of subscribers
Enabled
Here you can enable/disable the synchronisation of Oxid eShop subscribers/unsubscribers with Maileon.
Initial permission in Maileon
None: No permission. The contact will not receive newsletters, only transaction emails (e.g. reservation confirmation mail).
Single Opt-in: Permission was simply granted, e.g. by entering an email address in a form. This method technically allows the contact to receive newsletters, but does not ensure that the email address belongs to the person who entered it.
Confirmed Opt-in: With the confirmed opt-in, a confirmation e-mail is sent to the e-mail address after registering for the newsletter. However, this does not contain an additional confirmation link as with the double opt-in, the newsletter registration is valid immediately.
Double Opt-in: With this permission, a confirmation email with a confirmation link is sent to the email address. Only when the link in the mail has been clicked and thus the interest in the entry has been confirmed, the contact can be sent.
Double Opt-in Plus: Double opt-in including consent for single user tracking. Please note: Without individual user tracking, no openings, clicks, etc. may be traced back to individual users and significant data for evaluating newsletter performance is missing.
Other: If no permission can be proven, the "Other procedure" method can be selected. However, this is expressly not recommended. Permission must always be proven.
If DOI process is enabled the permission must be lower then double Opt-in (DOI), so the valid permissions are None, Single Opt-in or Confirmed Opt-in!
DOI process enabled
If we enable the DOI process, then when the contact is created a confirmation email will be sent to the email address with a confirmation link, which if the contact clicks on will give them Double Opt-In Plus access to Maileon, regardless of what we have set in the above setting.
If at OXID admin (Core settings->Settings->Administration) the Double Opt-In settings is turned off and this option is not turned onoff too, the contact will receive the permission set above instantly, without any confirmation.
...
If at OXID admin (Core settings->Settings->Administration) the Double Opt-In settings is turned on and this option is turned off, OXID will send the DOI confirmation mail.
If at OXID admin (Core settings->Settings->Administration) the Double Opt-In settings is turned on and this option is turned on, Maileon will send the DOI confirmation mail.
DOI mailing id
Here you can enter a DOI mailing ID, which determines which DOI mailing should be triggered as soon as a contact subscribes to the newsletter. The identifier can be set in Maileon or retrieved from the corresponding DOI mailing in the default settings. If the Maileon account has a default DOI mailing set in the settings, this field does not need to be filled in. Common mistake:
The DOI process above will be enabled but the DOI key is not specified here and no default DOI mailing is set in the Maileon account.
Webhook token for DOI confirmation and unsubscription
We will use webhooks from Maileon to synchronise DOI confirmers and unsubscribers back. These webhooks need to be set up in Maileon, to set them up you need to enter this token. The token can be any text that does not contain spaces.
Initial synchronisation
Enabled
Initial synchronisation allows you to create subscribers in Maileon that were created before using the plugin. It is sufficient to run this once when you start using the plugin, after that the subscribers will be synchronized automatically. You can enable synchronisation here, see below for more information on running synchronisation.
Permission if imported contacts
You can set the permission for contacts to be created during import. This is a final permission, the DOI process will not run.
None: No permission. The contact will not receive newsletters, only transaction emails (e.g. reservation confirmation mail).
Single Opt-in: Permission was simply granted, e.g. by entering an email address in a form. This method technically allows the contact to receive newsletters, but does not ensure that the email address belongs to the person who entered it.
Confirmed Opt-in: With the confirmed opt-in, a confirmation e-mail is sent to the e-mail address after registering for the newsletter. However, this does not contain an additional confirmation link as with the double opt-in, the newsletter registration is valid immediately.
Double Opt-in: With this permission, a confirmation email with a confirmation link is sent to the email address. Only when the link in the mail has been clicked and thus the interest in the entry has been confirmed, the contact can be sent.
Double Opt-in Plus: Double opt-in including consent for single user tracking. Please note: Without individual user tracking, no openings, clicks, etc. may be traced back to individual users and significant data for evaluating newsletter performance is missing. newsletter performance is missing.
Other: If no permission can be proven, the "Other procedure" method can be selected. However, this is expressly not recommended. Permission must always be proven.
Order confirmation transactions send to Maileon
Enabled
Here you can allow orders to be transferred to Maileon as contact events. See below for more details.
RSS feed
Enabled
Here you can enable the generation of RSS feed for your products. See below for more details.
Abandoned carts
Enabled
Here you can enable the abandoned cart functionality. (Cronjob needed)
After how many minutes a shopping cart should be reminded
here you can set after how many minutes the plugin will send abandoned cart transactions to Maileon. The minimum is 5 minutes and can be increased by 5 minute intervals.
...
Contact fields at Maileon
Name | Maileon type | Datatype | |
---|---|---|---|
| standard | string | |
| standard | string | |
| standard | string | |
| standard | string | |
| standard | string |
|
| standard | string | |
| standardstring | date (Y-m-d) | |
| standard | string | |
| standard | string | |
| standard | string | |
| standard | string | |
| standard | string | |
| standard | string | |
| custom | boolean | |
| custom | boolean | |
| custom | string | |
| custom | string | |
| custom | string | |
| custom | string | |
| custom | string | |
| custom | string |
RSS feed
Once you have enabled RSS feed in the plugin settings, you can access the feed at the following url:
...