Magento 2 Newsletter Popup v4.x Configuration

Configuration

General

Here you will learn how to configure our Magento Newsletter Popup Extension v4 correctly. Follow the steps below.

Step-by-Step action:

  1. Go to the “Plumrocket” tab in the main menu.
  2. Select Newsletter Popup Extension -> “Configuration” section.
  3. Enable Extension”: this option allows you to enable or disable this Newsletter Popup extension.
  4. Option “Serial Key”: enter the unique serial key provided to you after the purchase of the extension. Note: In most cases, this field will be pre-filled with a serial key automatically and the green checkmark will be displayed. In order to find and paste your serial key manually, read the Serial Key Activation article.
  5. Option “Use Google Analytics Tracking”: allows you to enable or disable Google Analytics Tracking for your popups.
  6. Enable Subscription History“: if enabled, this option allows to save all user interactions with Popups in the Magento database.
  7. “Option “Erase Old Subscription History“: allows selecting the period of time after which the Subscription History will be erased.
  8. “Disable History for IP addresses”: this option allows you to specify the IP-addresses with the history of records that will not be saved in the Magento database.
  9. Option “Cookie Timeout Usage“: allows you to use two different types of cookies: “Global cookie for all popups” and “Separate cookie for each popup”. This way admin will be able to record the time when the popup was closed for each popup independently. When 2or more popups are enabled at the same time, the user will see the 2nd popup after the page refresh even if the 1st popup was just closed.
  10. “Newsletter Popup Thumbnail”: indicates if the “Thumbnail Generation” option for the popup is enabled or disabled.
  11. The “Find Wkhtmltoimage Tool” button: allows you to locate this tool after installation on the server, or find it in case it was moved within the file system.
1 configuration newsletter popup magento 2 v.3.jpg

Important Information:

In order to enable Newsletter Popup Thumbnail, you will need to have the wkhtmltoimage command line tool installed as outlined here

Device Screen Sizes

Step-by-Step action:

  1. Option “Desktop”: allows you to set the width of the Desktop screen for proper display of the Newsletter Popup. By default, it is 992 pixels or greater.
  2. Option “Tablet”: allows setting the width of the Tablet screen. By default, it is 768 pixels or greater.
  3. Option “Mobile”: allows setting the width of the Mobile device screen. By default, it is less than 768 pixels.
3 configuration newsletter popup magento 2 v.3.1.2.jpg

Disposable Emails

Step-by-Step action:

  1. “Reject Subscriptions from Disposable Email Addresses”: if enabled, this option will reject subscription for the email addresses from the list of disposable email services.
  2. “Disposable Email Services”: allows you to enter the blacklisted domain names. Newsletter subscriptions will be rejected for the email addresses from these domains.
  3. Press the “Save Config” button to save the settings configured.
4 configuration newsletter popup magento 2 v.3.jpg

Google reCHAPTCHA

Step-by-Step action:

  1. “Google reCAPTCHA Site Key”: log into your account at google.com/recaptcha to generate your Google reCAPTCHA Site Key.
  2. “Google reCAPTCHA Secret Key”: log into your account (by the link provided above) to generate your Google reCAPTCHA Secret Key.
Magento 2 newsletter popup v.3.1.2.jpg

Newsletter Popup CRM Integrations Configuration

Manage Newsletter Popups

This tab allows you to preview and edit Popups. In order to access this management page, follow the steps as described below.

Step-by-Step action:

  1. Go to the “Plumrocket” tab in the main menu -> select “Newsletter Popup” extension -> navigate to the “Manage Popups” section.
5 configuration newsletter popup magento 2 v.3.jpg

Step-by-Step action:

  1. You can add a new popup by pressing the “Add Popup” button. Please, read the instructions here to configure it correctly.
  2. The “Thumbnail” column allows you to see the thumbnail image of the popup.
  3. “ID”: allows you to see and search by the newsletter ID in the grid.
  4. The “Name” column indicates the name of the popup.
  5. The “Type” column indicates whether it is a popup window or a widget template.
  6. The “Views” column allows you to see the number of users’ views of the popup.
  7. The “Subscriptions” column allows you to see the number of users that have been subscribed using a specific popup.
  8. The “Conversion Rate” column shows the conversion rate of the popup.
  9. The “Orders Count” column allows you to see the number of orders made with this popup.
  10. The “Total Revenue” column shows the total revenue gained with this popup.
  11. The “Start Date” column indicates the Start Date of the Newsletter Popup.
  12. The “End Date” column indicates the End Date of the Newsletter Popup.
  13. The “Visible in” option allows you to see the store view(s) that the popup is visible in.
  14. The “Status” option: shows the status of the popup: “Enabled” or “Disabled”.
  15. The “Preview” button opens the popup in a separate window for your review.

If you want to edit a popup, click on it in the grid and follow the “Add New Popup” instructions to do it correctly.

6 configuration newsletter popup magento 2 ver.4.jpg

Add New Popup

General

Step-by-Step action:

  1. Go to the “General” tab of the settings.
  2. Option “Popup Name”: allows you to specify the Newsletter Popup name.
  3. The “Status” option allows you to enable or disable the popup.
  4. The “Type” option allows you to specify the popup type: a popup window or a widget template. Please, note: if you select the Widget Template option in this field, you will be creating a Newsletter Popup widget. In order to display the created Newsletter Popup widget on your store, follow the How to Display Newsletter Popup Widgets in the current article. You can also display it in another way with the default Magento Widget functionality.
  5. Option “Use Coupon Code”: allows you to select the Shopping Cart Price Rule with coupon (if any). For more information about the Shopping Cart PriceRules, please read Creating Shopping Cart Price Rules In Magento 2 article.
7 configuration newsletter popup magento 2 v.4.jpg

Step-by-Step actions:

  1. Options “Start Date”, “End Date”: allow you to set the Start Date and End Date of the Newsletter Popup.
  2. Option “Subscription Success Page”: allows you to select the page where the subscriber will be transferred to after a successful subscription.
  3. Option “Send Autoresponder Email”: allows you to send the notification email to the user after a successful subscription.
  4. Option “Autoresponder Email Template”: allows you to select the template that will generate a notification email about the successful subscription.
8 configuration newsletter popup magento 2 v.4.jpg
Coupon Settings

Step-by-Step action:

  1. Option “Code Length”: allows you to set the Discount Coupon Code length.
  2. Option “Code Format”: allows you to select the Discount Coupon Code format. Possible options are “Alphanumeric”, “Alphabetical” or “Numeric”.
  3. “Coupon Expiration Time”: allows you to specify the expiration time of the coupon in days, hours, minutes. Please, note: This option is only available for shopping cart rules with auto-generated coupons.
7a configuration newsletter popup magento 2 ver.4.jpg

Information:

After the user has successfully subscribed to the Newsletter and the Coupon Code is generated, you can see the Coupon Expiration Date in the Shopping Cart Rule section.

Signup Form

Step-by-Step action:

  1. Option “User Sign-Up Method” allows you to set the way for a customer’s sign-up process. Possible options are “Sign-up for email newsletter only” and “Register customer account & sign-up for newsletter”.
  2. Option “Enable form fields“: allows you to select, enable, rename and define the sort order for the additional fields on users sign-up form.
7b configuration newsletter popup magento 2 v.3.1.1 up.jpg

Display Settings

Step-by-Step action:

  1. Go to the “Display Settings” tab.
  2. Option “Popup theme“: Press the “Choose Theme” button to select the theme for this Popup.
  3. Option “Display Popup”: allows you to select the option where the Popup will be displayed. Possible options are: “After time delay“, “When leaving the site (out of focus)”, “On Page Scroll”, “On Mouse over”, “On click”, and “Manually”. Note: If you select the “On Mouse Over” or “On Click” display method – the “CSS Selector” field will appear, where you can enter the “ID” or “Class Name” of the object you want to use to trigger the newsletter popup. For the “Manually” option, please, check our Developer’s Guide.
  4. “Popup Time Delay”: this option allows you to indicate the delay time after which the Popup displays.
  5. Option “Cookie Timeout (days)“: allows you to set the time frame for the cookies in days, hours, minutes, seconds. Cookies are used to track whether a user clicked on the “subscribe” or “cancel” button. If the user chooses to cancel the subscription, then the popup will be displayed again only after a specified amount of days. Enter ‘0’ in this field to never display the newsletter popup again after it was closed for the first time.
  6. Option “Animation”: allows you to select different animation effects for a popup.
8 configuration newsletter popup magento 2 ver.4.jpg

Step-by-Step actions:

  1. Option “Visible In”: allows you to choose which Store view(s) the Popup will be visible on.
  2. Section “Display Popup Restrictions”: here, you can create special display popup restriction rules. As a result of these rules, the popup will be displayed only if the conditions you’ve created are true or false. Do not add rules if you want to display a popup to all customers on all pages and devices.
  3. Default Product SKU“: if you choose “21. Rectangle”, “22. Orange Wall”, “23. Grey Edge” or “24. Amazing Shapes” template, you can specify the product SKU in this field and output this product on the popup.
  4. Use Current Product for Popup“: set to “No” if you have specified the product SKU in the previous field. Otherwise, set to “Yes” to output the product a customer is currently viewing on the popup window. You can benefit from this option in the following way: set a coupon code and select “When leaving the site (out of focus)” in the “Display Popup” option. In this case, the popup will appear and offer a discount when a customer tries to close the page. This drives the customer to use a coupon code and make a purchase.
9 configuration newsletter popup magento 2 ver.4.jpg

Important Information:

How to calculate when the right time to display the newsletter popup is? A good starting point would be your site statistics. In Google Analytics, you can go to Audience -> Behavior -> Engagement and see when most visitors leave your site. The default suggested value is 5 seconds. However, we always suggest testing and comparing different time delays vs. the number of email signups as every website is different.

Text & Labels

Step-by-Step action:

  1. Go to the “Text Labels” tab.
  2. Option “Title”: allows you to set the title which will be used for Newsletter Popup.
  3. Option “Description”: allows you to indicate some description for the Popup if needed.
  4. Option “Success Message”: lets you set the message that will show up after the successful subscription. You can use {{coupon_code}} variable to autogenerate a coupon code and {{coupon_expiration_date}} variable to autogenerate the time of the coupon code expiration.
  5. Option “Submit Button”: allows you to create a text for the “Submit” button of the Popup.
  6. Option “Cancel Button”: lets you create a text for the “Cancel” button of the Popup.
9 configuration newsletter popup magento 2 ver.3.3.0.jpg

Theme Template

Step-by-Step action:

  1. Go to the “Theme Template” tab.
  2. Option “HTML Template”: here you can edit the HTML code of the template. The “Insert Image” option allows you to upload images to your theme template.
  3. Option “CSS Styles”: here you can edit the CSS Styles code of the template.
  4. Press the “Save Popup” button to save your Newsletter Popup.
10 configuration newsletter popup magento 2 v.3.3.0.jpg

Integrations

Step-by-Step action:

  1. Navigate to the “Integrations” tab to enable each integration separately for this Newsletter popup.
  2. Enable or disable Mailchimp integration for this newsletter popup.
  3. “User Subscription Mode”: lets you allow users to subscribe to the list of their choice or automatically subscribe each new user to all Mailchimp lists. Multiple options are available here.
  4. Contact Lists allows you to choose the lists in MailChimp that your customers will be able to subscribe to.
  5. Enable or disable other Integration for this popup, e.g., Klavio, GetResponse, etc.
10a configuration newsletter popup magento 2 v.3.3.0.jpg

Popup View on Store

Here is how the newsletter popup (with Chocolate theme) will look like on frontend.

Step-by-Step action:

  1. This is how your title section will look like.
  2. Here is how the description text section will be displayed.
  3. This is the signup section of the newsletter popup.
  4. This is how the social media login button will be displayed. Note that Newsletter Popup Extension has built-in support of Twitter & Facebook Login extension.
Theme newsletter popup magento 2 v3.jpg

This is how the newsletter popup (with Right Slide Out theme) will look like on frontend once enabled.

Step-by-Step action:

  1. The title text section of this popup theme is also a button that customers can press to show or hide the popup.
2 theme newsletter popup magento 2 v3.jpg

Manage Newsletter Popup Themes

Step-by-Step action:

  1. Press the “Plumrocket” tab in the menu.
  2. Select the “Newsletter Popup” -> “Manage Themes”.
11a configuration newsletter popup magento 2 v.3.jpg

Step-by-Step action:

  1. You can add a new theme by pressing the “Add New Theme” button.
  2. “Thumbnail” column: allows you to see the thumbnail image of the newsletter popup theme.
  3. “Theme Name”: allows you to see the name of the theme.
  4. “Updated At” column: shows the date when the popup theme has been updated.
  5. “Created At” column: shows the date when the popup theme has been created.
  6. The “Type” column shows the type of the newsletter popup theme.
  7. The “Preview” button opens the popup in a separate window where you can preview the popup theme.
  8. The “Action” column allows you to edit the required theme.
11 configuration newsletter popup magento 2 ver.3.jpg

Add New Theme

In order to configure your new Magento 2 Newsletter Popup Theme, please, follow the step-by-step instructions below.

Step-by-Step action:

  1. Option “Theme Name”: allows you to specify the name for your new theme.
  2. Option “HTML Template”: here you can add and edit the HTML code. The “Insert Image” button allows you to upload and insert images to your new theme.
  3. Option “CSS Styles“: allows you to add and edit the CSS Styles code.
  4. Press the “Save Theme” button to save your theme.
12 configuration newsletter popup magento 2 v.3.jpg

Newsletter Popup History

This tab allows you to preview the Newsletter Popup History in your Magento 2.

Step-by-Step action:

  1. Go to the “Plumrocket” tab in the main menu.
  2. Select “Newsletter Popup” Extension.
  3. Press the “History” tab.
13 configuration newsletter popup magento 2 v.3.jpg

How to change default theme images manually

In this part, you will learn how to change default theme images manually. Follow the steps below.

1. By default, images are located here:

/app/code/Plumrocket/Newsletterpopup/view/frontend/web/images/templates

In order to change any image (that is used for all popups) from the folder above, you need to copy the image to be changed to the following folder:

/app/design/frontend/[VendorName]/[YOUR_THEME]/Plumrocket_Newsletterpopup/web/images/templates

where [VendorName] is the name of the developer of your theme,

where [YOUR_THEME] is the name of your theme.

For example, if you need to overwrite the image “newbg1.jpg”- you need to move it to:

/app/design/frontend/[VendorName]/[YOUR_THEME]/Plumrocket_Newsletterpopup/web/images/templates/newbg1.jpg

Once the image is moved, you can start editing it.

2. If you need to replace the image for one popup only:

Go to the specific popup configuration > select “Theme Template” tab > change the image’s location.

Note: Images can be written via both Html or CSS. You just need to find the image in the code and indicate the new path and name for it. The path can be indicated the same way as you do for the CMS pages, for example:

{{view url="Plumrocket_Newsletterpopup::images/templates/theme2_logo.jpg"}}

The path can be indicated according to the skin folder or media folder, you can check this by clicking the F1 button in the template editor.

Newsletter Popup Thumbnail Generation

At some point in order to enable Newsletter Popup thumbnail generation, you will need to install the wkhtmltoimage command line tool (which is a part of wkhtmltopdf command line tool). This option is disabled by default as shown below.

Step-by-Step action:

  1. In your Magento 2 Admin Panel, go to the “Plumrocket” tab.
  2. Select “Newsletter Popup Extension” > “Configuration” section.
  3. As you can see, the “Thumbnail Generation” option is disabled by default.
15 newsletter popup v4 magento 2.jpg

This option is used for generating Newsletter Popup thumbnails that display in the “Manage Popups” grid as shown below.

Step-by-Step action:

  1. Go to the “Manage Popups” section of the Newsletter Popup extension.
  2. Thumbnails of your Newsletter Popups will be available in the grid once this option is enabled.
16 newsletter popup v3 magento 2.jpg

Important Information:

Please, note that enabling this option is not obligatory, however, it is a useful tool that will help the admin to visually distinguish multiple popups at the backend.

In order to enable the Newsletter Popup Thumbnail Generation option, follow the step-by-step instructions below.

Step-by-Step action:

  1. Go to wkhtmltopdf official page and click on the “Downloads” link .
Wkhtmltopdf 1 newsletter popup v3 magento 2.jpg

Step-by-Step action:

  1. Choose and download the needed archive from the list.
Wkhtmltopdf 2 newsletter popup v3 magento 2.jpg

Important Information:

Once you’ve downloaded the archive/file – you need to pass it to your server administrator (or to your hosting support) with a request to install it on your server.

After the successful installation of wkhtmltopdf command line tool for Newsletter Popup Thumbnail Generation, the according option should become enabled in your Magento backend as shown below.

Step-by-Step action:

  1. In your Magento Admin Panel, go to the “Plumrocket tab > “Configuration” section of the Newsletter Popup Extension.
  2. You will be able to see that the “Thumbnail Generation” is now enabled.
17 newsletter popup v3 magento 2.jpg

How to Display Newsletter Popup Widgets on Magento Store

In this section, you will learn how to create and display Newsletter Popup Widgets on your Magento store. Please, follow the steps below.

Step #1

Make sure you have created a Newsletter Popup widget. If you have not, please follow the Add New Popup instructions to create a widget, and make sure to select Widget in the Type option.

Step #2

On Magento stores, you can insert widgets into CMS static blocks or into CMS pages. In this example, we will show the case of CMS static blocks.

Please, follow the instructions below to learn how to insert a Newsletter Popup Widget into a CMS block:

Step-by-Step actions:

  1. Go to the Content tab in the main Magento menu.
  2. In the Elements section, select Blocks.
  3. In the Blocks grid, find the CMS block where you want to insert a widget.
  4. In the Action column of the needed block, click on Select > Edit.
magento 2 newsletter popup extension widgets.png

Step-by-Step actions:

  1. In the WYSIWYG editor, click on the place where you need to insert a widget.
  2. Press the Insert Widget icon.
2 magento 2 newsletter popup extension widgets.png

Step-by-Step actions:

  1. Widget Type“: in this field, select the Newsletter Popup Form.
  2. Widget Template“: select the widget template you have created in Add New Popup section.
  3. Press the Insert Widget button to insert the selected widget into the CMS block.
3 magento 2 newsletter popup extension widgets.png

Step-by-Step actions:

  1. Here you can see how the inserted widget is displayed in the WYSIWYG editor.
  2. Click on the Save button to save your changes.
4 magento 2 newsletter popup extension widgets.png
  1. This is how the inserted widget looks in the frontend.
5 magento 2 newsletter popup extension widgets.png

Important Information:

You can also display Newsletter Popup widgets in another way with the default Magento Widget functionality.

Was this article helpful?