X hide

Magento Newsletter Popup v2.x Configuration

From Plumrocket Documentation

You are viewing:  Newsletter-popup-icon-32.png  Newsletter Popup

Configuring Newsletter Popup 2.x Extension

Here you will learn how to correctly configure our Magento Newsletter Popup Extension v2.x. To do this, follow the instructions below.


Information Sign sm.png Step-by-Step action:
  1. Press "Plumrocket" tab in the menu.
  2. Select "Newsletter Popup".
  3. Select "Configuration".


Newsletter popup v2x conf 1.jpg


Information Sign sm.png Step-by-Step action:
  1. Enable Extension: allows you to enable or disable this Newsletter Popup extension.
  2. Option "Serial Key": enter unique serial key provided after the purchase for legitimate and proper functioning of your extension. Note: In most cases this field will be pre-filled with serial key automatically and the green check mark will be displayed. Otherwise please read article Serial Key Activation in order to find and paste your serial key manually.
  3. Option "Use Google Analytics Tracking": allows you to select whether or not Google Analytics Tracking will be used for your Popups.
  4. "Enable Subscription History": if enabled, this option allows to save all user's interactions with Popups in magento database.
  5. Option "Erase Old Subscription History": allows to select the period of time after which the Subscription History will be erased.
  6. "Disable History for IP-addresses": this option allows you to indicate the IP-addresses, which interactions with popups will not be saved in magento database.
  7. 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 time when popup was closed for each popup independently. When 2 or more popups are enabled at the same time, the user will see 2nd popup after the page refresh even if the 1st popup was just closed.
  8. "Newsletter Popup Thumbnail": indicates if "Thumbnail Generation" option for the popup is enabled or disabled.
  9. "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.


Newsletter popup v2x conf 2.jpg


Attention green.png Important Information:

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


Information Sign sm.png Step-by-Step action:
  1. "Enable Synchronization": if enabled, this option allows you to transfer collected emails to your Mailchimp List(s).
  2. Option "Mailchimp API Key": allows you to indicate your MailChimp API key. This is an API key which you can retrieve from your MailChimp account. (For more information about Mailchimp API key please read this article). Please make sure to save your changes once you indicate the API key.
  3. Option "Mailchimp Lists": allows to select the Mailchimp Email List(s) where the collected emails will be saved to. (List(s) will appear after you indicate your Mailchimp API Key)
  4. Option "Double opt-in": allows to activate Double opt-in. Note: For more information about double opt-in process in MailChimp please read this article.
  5. Option "Account Details": shows your MailChimp Account details. (They will appear after you indicate your Mailchimp API Key)
  6. Option "Mailchimp Fields Mapping": lets you to setup a relation between your newsletter popup fields and MailChimp list fields. This will allow you to save your newsletter subscribers additional data (including Coupon Codes) directly to your Mailchimp account. Also it lets you send a Welcome Email to your subscribers automatically, using MailChimp service instead of Magento.

Note: MailChimp paid plans allow you to include Coupon Code into automatically sent emails, even if "double opt-in" option is disabled. Otherwise, "double opt-in" is required to be enabled to make these procedure automated for Magento admin. Please refer to the following article for more information on how to synchronize Newsletter Popup data fields with your MailChimp.


Newsletter popup v2x conf 3 new.jpg


Information Sign sm.png Step-by-Step action:
  1. Option "Desktop": allows you to set the width of Desktop screen for proper display of Newsletter Popup. By default it is 992 pixels or greater.
  2. Option "Tablet": allows to set the width of Tablet screen. By default it is 768 pixels or greater.
  3. Option "Mobile": allows to set the width of Mobile device screen. By default it is less than 768 pixels.


magento newsletter template


Information Sign sm.png 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. Option "Disposable Email Services": allows you to indicate the blacklisted domain names. Newsletter subscriptions will be rejected for the email addresses from these domains.
  3. Press "Save Config" button to save your settings.


Newsletter popup v2x conf 5.jpg

Managing Newsletter Popups

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


Information Sign sm.png Step-by-Step action:
  1. Press the “Plumrocket” tab in the menu.
  2. Select “Newsletter Popup”.
  3. Select “Manage Popups”.


Newsletter popup v2x conf 6.jpg


Information Sign sm.png Step-by-Step action:
  1. You can add new popup by clicking on "Add Popup" button.
  2. "Thumbnail" column: allows you to see the thumbnail image of the popup.
  3. "Name" column: indicates the name of the popup.
  4. "Views" column: allows you to see the amount of users' views of the popup.
  5. "Subscriptions" column: allows you to see the amount of users' that were subscribed using specific popup.
  6. "Conversion Rate" column: shows the conversion rate of the popup.
  7. "Orders Count" column: allows you to see the amount of orders made with this popup.
  8. "Total Revenue" column: shows the total revenue gained with this popup.
  9. "Start Date" column: indicates the Start Date of the Newsletter Popup.
  10. "End Date" column: indicates the End Date of the Newsletter Popup.
  11. You can duplicate, enable, disable or delete the selected popup(s) by selecting the according action from "Actions" dropdown.
  12. Press "Submit" button to confirm the needed action.
  13. "Preview" button opens the popup in the separate window for your review.


Newsletter popup v2x conf 7.jpg


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


Information Sign sm.png Step-by-Step action:
  1. Option "Popup Name": allows you to indicate Newsletter Popup name.
  2. "Status": this option allows you to enable or disable this extension.
  3. Option "Use Coupon Code": allows you to select the Shopping Cart Price Rule with coupon (if any). For more information about the rules please read Creating Shopping Cart Price Rules In Magento.
  4. Options "Start Date", "End Date": allow you to set the Start Date and End Date of the Newsletter Popup.
  5. Option "Subscription Success Page": allows you to select the page where the subscriber will be transferred to after successful subscription.
  6. Option "Send Autoresponder Email": allows you to choose whether or not the notification email about successful subscription will be sent to a client.
  7. Option "Autoresponder Email Template": allows you to select the template that will generate notification email about successful subscription.
  8. Option "Code Length": allows you to set the Discount Coupon Code length.
  9. Option "Code Format": allows you to select the Discount Coupon Code format. Possible options are: "Alphanumeric" , "Alphabetical" or "Numeric".


Newsletter popup v2x conf 8.jpg


Information Sign sm.png Step-by-Step action:
  1. Option "User Sign-Up Method": allows you to select the way for customer 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 sort order for the additional fields on users sign-up form.
  3. Option "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. Option "Enable Mailchimp Lists": allows you to choose the lists in MailChimp that you customers will be able to subscribe to.


Newsletter popup v2x conf 9.jpg


Information Sign sm.png Step-by-Step action:
  1. Option "Popup theme" : Press "Choose Theme" button to select the theme for this Popup.
  2. Option "Display Popup": allows you to select the option where the Popup will be displayed. Possible options are: "After time delay", "When leaving site (out of focus)", "On Page Scroll", "On Mouse over", "On click" and "Manually". Note: If you select "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 refer to Magento Newsletter Popup v1.x Developers Guide and API Reference section for more information.
  3. "Popup Time Delay": this option allows you to indicate the delay time after which the Popup displays.
  4. Option "Cookie Timeout (days)": allows you to set the time frame for the cookies in days. Cookies are used to track whether user clicked on "subscribe" or "cancel" button. If the user choose to cancel the subscription, then the popup will be displayed again only in specified amount of days. Enter '0' in this field to never display the newsletter popup again after it was closed for the first time.
  5. Option "Animation": allows you to select different animation effects for popup.
  6. Option "Visible In": allows you to choose for which Store view(s) the Popup will be visible.
  7. Section "Display Popup Restrictions": here you can create special display popup restriction rules. As the result of these rules the popup will be displayed only if the conditions you've created are true or false.


Newsletter popup v2x conf 10 v2.0.3.jpg


Attention green.png Important Information:

How to calculate when is the right time to display newsletter popup? 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 to test and compare different time delays vs number of email signups as every website is different.


Information Sign sm.png Step-by-Step action:
  1. Option "Title": allows you to set the title which will be used for Newsletter Popup.
  2. Option "Description": allows you to indicate some description for the Popup if needed.
  3. Option "Success Message": lets you set the message that will show up after the successful subscription.
  4. Option "Submit Button": allows you to create a text for "Submit" button of the Popup.
  5. Option "Cancel Button": lets you create a text for "Cancel" button of the Popup.


Newsletter popup v2x conf 11.jpg


Information Sign sm.png Step-by-Step action:
  1. "Insert Image" button: allows you to upload and insert images to your theme template.
  2. Option "HTML Template": here you can edit the HTML code of the template.
  3. Option "CSS Styles": here you can edit the CSS Styles code of the template.
  4. Press "Save Popup" button to save your Newsletter Popup.


Newsletter popup v2x conf 12.jpg


Here's how the newsletter popup (with Chocolate theme) will look like on frontend once enabled.


Information Sign sm.png Step-by-Step action:
  1. This is how your title section will look like.
  2. Here's how the description text section will be displayed.
  3. This is the sign-up section of 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.


Newsletter popup v2x conf 17.jpg


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


Information Sign sm.png 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.


Newsletter popup v2x conf 18.jpg


Managing Newsletter Popup Themes

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


Information Sign sm.png Step-by-Step action:
  1. Press the “Plumrocket” tab in the menu.
  2. Select “Newsletter Popup”.
  3. Select “Manage Themes”.


Newsletter popup v2x conf 13.jpg


Information Sign sm.png Step-by-Step action:
  1. You can add new theme by pressing "Add New Theme" button.
  2. "Thumbnail" column: allows you to see the thumbnail image of the newsletter popup theme.
  3. "Updated At" column: indicates when the popup theme was updated.
  4. "Created At" column: indicates when the popup theme was created.
  5. You can duplicate or delete the selected popup theme(s) by selecting the according action from "Actions" dropdown.
  6. By pressing "Submit" button you will confirm the needed action.
  7. "Preview" button: opens the popup in the separate window where you can preview the popup theme.
  8. "Edit" link: by clicking on this link you can edit your popup theme. Please note that default themes cannot be edited. Instead you can duplicate the default theme and then edit it.


Newsletter popup v2x conf 14.jpg


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


Information Sign sm.png Step-by-Step action:
  1. Option "Theme Name": allows you to indicate the name for your new theme.
  2. "Insert Image" button: allows you to upload and insert images to your new theme.
  3. Option "HTML Template": here you can add and edit the HTML code.
  4. Option "CSS Styles": allows you to add and edit the CSS Styles code.
  5. Press "Save Theme" button to save your theme.


Newsletter popup v2x conf15.jpg


Newsletter Popup History

This tab allows you to preview the Newsletter Popup History.


Information Sign sm.png Step-by-Step action:
  1. Press the “Plumrocket” tab in the menu.
  2. Select “Newsletter Popup”.
  3. Select “History”.


Newsletter popup v2x conf 16.jpg


Changing 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:

skin/frontend/base/default/images/plumrocket/newsletterpopup/templates

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

skin/frontend/YOUR_THEME/default/images/plumrocket/newsletterpopup/templates

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:

skin/frontend/YOUR_THEME/default/images/plumrocket/newsletterpopup/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 location for the image. 

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:

{{skin url="images/plumrocket/newsletterpopup/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 Extension for Magento Newsletter Popup Extension for Magento

Navigation