Magento plugin for sending transactional messages with magnews

The plugin developed by Cosmobile addresses two primary needs of all e-commerce managers who have their store on Magento / Adobe Commerce. 

The first issue it resolves is overcoming all the difficulties related to layout, updates, maintenance, and better adherence to the brand identity of the main transactional communications that form a fundamental part of the buying experience for customers of every e-commerce. 
In fact, with this plugin you can leverage not only the full power and capability of magnews email delivery but also the flexibility, ease, and autonomy in managing the templates of transactional messages directly on magnews, utilizing the Giotto editor and Inspire templates. 

The second functionality allows for immediate sending of all contacts registering through the newsletter subscription forms to magnews, triggering the Welcome program and onboarding programs right away using magnews Marketing Automation tools. 

Plugin compatibility

The current version of the plugin is compatible with: 

• Magento Open Source 2.4.5
• Adobe Commerce 2.4.5

Installation procedure

Installing the module via composer

To install the module via composer use the command:

composer config repositories.magnewsconnector vcs https://github.com/diennea/cosmobile-magnewsconnector
composer require cosmobile/magnewsconnector

Subsequently execute:

bin/magento setup:upgrade
bin/magento module:enable Cosmobile_MagnewsConnector
bin/magento setup:di:compile
bin/magento setup:static-content:deploy

To use this method, you must have a GitHub account and request access to the private repository of the plugin in advance through Helpdesk. 

Installing the module in app/code

Copy the content of the module to

app/code/Cosmobile/MagnewsConnector

Subsequently execute:

bin/magento setup:upgrade
bin/magento module:enable Cosmobile_MagnewsConnector
bin/magento setup:di:compile
bin/magento setup:static-content:deploy

Permission configuration

For the configuration, the module uses two different permissions:

• Configuration of the module for integration with magnews; 
  Required permissions:

  • Stores → Settings → Configuration → Cosmobile MagnewsConnector

• Association of Magento templates to be managed with magnews

  Required permissions:

  • Cosmobile MagnewsConnector

Configuration for integration with magnews

To configure the integration, it is necessary to fill in the fields as indicated in the section:

Below is an explanation of the different sections.

Magnews API configuration

Contains the parameters, retrievable from magnews, to activate the integration via API from Magento.

Once the parameters are configured, it is important to remember to save the configuration before proceeding with the authentication button.

When the button is pressed, the saved data will be used to activate the integration between Magento and magnews.

The Enabled configuration allows you to enable/disable the operational functionality of the integration with magnews and therefore the module.

Magnews general configuration

Among the general configurations, you need to indicate the magnews database ID on which both transactional messaging and contact subscription activities (if active) will be based. 

Magnews mail configuration

Enable the plugin feature that allows the sending of transactional emails associated and configured in the specific section via magnews, bypassing the standard sending of Magento.

By setting this configuration to Yes, the configured emails will be sent via magnews; otherwise, this plugin feature remains disabled.  

Magnews newsletter configuration

Allows you to activate the synchronization of newsletter subscribers from Magento to magnews.
It is possible to associate and synchronize any additional attributes of the Newsletter subscribers, present in the standard Magento table (newsletter_subscriber), by their code. 

The ID for each additional attribute can be directly retrieved from magnews, in the Contact Fields management section.  

Association of Magento templates to be managed with magnews

The section on the Magento side can be accessed from:

The grid allows you to quickly check the transactional email templates of Magento associated with the integration with magnews.

If email sending via magnews is active, all transactional emails from Magento that use a template with an active association will be sent via magnews, using the template defined on the magnews platform.

The section allows you to add new templates to associate, remove associations, or modify existing ones.

Each association is identified by:

• the reference to a Magento template
• the reference to a magnews template (identified by name or ID)

If both are specified, the name takes precedence over the ID.

Each association can be activated or deactivated individually.

If an association is deactivated, the respective transactional email will not be sent via magnews but using the standard flow of Magento.

Conditions for sending the transactional email

• The configuration Magnews API Configuration → Enabled must be set to Yes
• The configuration Magnews mail configuration → Send mails with Magnews must be set to Yes
• An association has been created for the transactional email template from Magento in the section Marketing → Cosmobile Magnews Connector → Mail templates
• The association must have Status configured as Enabled
• The association must not have both configurations Magnews Mail template ID and Magnews Mail template Name empty.

In case of an error in sending the email via magnews, the email will be sent through the standard flow of Magento.

In case of using external SMTP servers for sending emails

To bypass the email sending performed by Magento (in favor of that of magnews), the standard flow of the platform is intercepted.

If external modules that interfere with this flow are present, for example, to allow the use of an external SMTP server instead of the Magento server, normal email sending may not be guaranteed. 

The third-party modules that have been verified for compatibility are:

• Mageplaza - Module SMTP: https://github.com/mageplaza/magento-2-smtp