MailChimper PRO
WordPress Newsletter Form Plugin
Documentation
Table of Content
- Item Name : MailChimper PRO - WordPress Plugin
- Minimum Required : WordPress Version 3.9
- Author by : Pantherius
- Support via Email : Contact Link
Thank you for purchasing my plugin. If you have any questions that are beyond the scope of this help file, please feel free to email via my user page contact form here.
With this attention-grabber WordPress Plugin, you can collect your visitor's email address on your website. It has a lot of optional customization options, but you can setup simply in minutes. Using the latest CSS3 animations with AJAX validation the Signup Form will build your email list effectively in no time. You can use it with MailChimp, but if you have any other email database manager, you can use it with that as well. In that case, the plugin will send you a message about every subscription with the user's email address, therefore you can easily add it to your own email list manager. You can also use this function as a signup notification.
Install Guide #back to top
If All files & documentation has been downloaded, then you need to unzip the file to get the installable WordPress Plugin ZIP file.
Upload via WordPress Admin
Use your WordPress Administration Page to browse and upload the plugin ZIP file. Pay attention to upload the correct ZIP, otherwise you will get an error message. If it happen, please unzip the downloaded file and upload the inner ZIP file since that will be the installable WordPress package.
Add New - #back to top
First, log in to the Administration area of your Wordpress website and select Plugins then Add New.
Browse - #back to top
Select Upload on the top of the page, browse the plugin ZIP file and click on the Install Now button.
Upload - #back to top
Click on the Activate Plugin link and the plugin will be active. After successful plugin activation, you will be redirected to the plugins' list page.
Activate - #back to top
Find the installed plugin in the list. You can now configure it in the plugin settings.
Upload via FTP
Unpack the plugin ZIP file to a folder, then copy all files with the main directory to your website wp-content/plugins folder.
Login to your administration area and activate the plugin.
How to Create New Form #back to top
Add new form with clicking on the New Form link on the left side under the MailChimper PRO main navigation menu. Enter the signup form name into the text field, then click on the New Form button.
The new form will be automatically created and you will be redirected to the form edit screen.
Visual Builder - #back to top
The form edit screens allows you to design your own newsletter form, including animations, color and font families. Click on the play button to check how the form actually looks. If you willing to use the form with MailChimp, then select it from the Mode select box. Mixed mode will send notification email for your specified email address below and also pass the subscribers details to MailChimp. Choose Mail mode to get signup notification only, this way you can add the subscribers manually to any email database manager, that is not compatible with the plugin yet. The Additional API option allows you to use the other Newsletter Auto Responder Services, those are listed under the Additional Newsletter Integrations accordion.
Custom Fields - #back to top
Custom fields allows you to add further fields to the subscription form. These fields are also compatible with the Newsletter Service Providers, such as MailChimp or Active Campaign. Click on the desired button, then specify the ID that will be associated with the custom field in your Newsletter Service Account. That means, if you have a text field with FNAME id in the form, you need to add the FNAME custom field in your MailChimp or Active Campaign Account as well. It is important to DO NOT use special characters, like symbols, space in the ID field.
The next step is to enter the display name of the field, then set up a warning message if the field is mandatory. Set ON the checkbox at the end of the row, if you want to set the field to required.
Additional Configuration - #back to top
- Preset: You can set predefined styles. The presets doesn't contains images, just the color and font settings. You can insert HTML image elements to display pictures in the title or in the content like on the demo page.
- Position: Specify the position of the popup
- Animation: You can set the incoming and outgoing animation type.
- Item Effect: Set the animation for the HTML elements in the form.
- Mode: If you using mailchimp mode, it will connect to your MailChimp account, with mail option, you will get a mail about every subscription. (Needs to set your email address under the Email Address for optional signup notifications option). The mixed mode results both of MailChimp and Notification mode. Use the Additional API mode if you would like to integrate the other service providers ONLY and you wouldn't like to get notification about each subscriptions.
- Font Family: Font Family of the Title of Signup Form. Select from more than 650 Google Font Styles.
- Content Font Family: Font Family of the content of Signup Form. Visit http://google.com/fonts and choose the one you like.
- Custom Fields: Click on the 'Add Custom Field' button and fill out the parameters in the inputs. id is a string that you can define in MailChimp. The plugin will pass the parameter and MailChimp will save the value for later use. The name parameter will be visible for the visitors as placeholder in the input field. If you set the field as mandatory, it is possible to define the warning text.
- Background Color, Title Font Color, Content Font Color, Subscribe Button Background, Subscribe Button Font Color, Close Button Color (rgb, rgba or hex color code): Allows to set custom color for the background, the signup button, the close icon, title and for the content.
- Animation Speed: Set the animation speed in seconds.
- Facebook APP ID: You can find it on Facebook after you created your Facebook Application. Go to this link to create your app: https://developers.facebook.com/apps
- Googleplus Client ID: Register on Google Plus, enable Google Plus API and get your Client ID on this link: https://console.developers.google.com/
- Google Plus API Key: You can also get your API Key on the link described above.
- Fields Margin: The vertical distance of the newly added custom fields from each other.
- Open with Link: With unchecked state, you can disable the option to open the form with clicking on a specified link (see Open with Link Section).
- Bottom Title: Add bottom-line text with smaller font size.
- Input Border Radius: The border radius of the input fields.
- Once per Filled Out: It won't display the popup for the users who already filled out. (using cookies)
- Once per User: Track users to prevent reopen signup form for the same users. This setting only works with autoopen and openbottom options. (you have to set the Cookie days)
- Filled Cookie Days: Days to do not display the form again for users, who already signed up.
- Close with Layer: Enable the option to close the form by clicking on the transparent background (you can use it only with setting Lock the Screen:on).
- Font Size, Content Font Size, Close Font Size: You can define the size of the title, content and the close icon.
- Font Weight, Content Weight (normal or bold): This is the font weight attribute of title and content.
- Title, Text, Placeholder Text, Subscribe Button Text: With this parameter, you can set the text of the title, the content, the email input placeholder and the Subscribe Button.
- Invalid Address, Signup Success: The callback message for invalid email address and the successful signup.
- Vertical Space, Horizontal Space: If you using the popup on any side of the screen, you can specify the vertical and horizontal distance relative to the side of the window in pixels.
- Border Radius: Set the radius of the popup form's border.
- Display at Bottom: If you set it on it will open automatically when the user reach the 90% of the screen while scrolling down the website. You can disable this feauture with unchecked state.
- Double Optin (MailChimp settings): The potential subscriber will get an email with a link to confirm their subscription. If they don't click this link, they won't be added to your list. To disable this confirmation, set false to this attribute.
- Update Existing (MailChimp settings): Existing subscribers will be updated with true value.
- Replace Interests (MailChimp settings): Flag to determine whether MailChimp replace the interest groups with the groups provided or MailChimp add the provided groups to the member's interest groups.
- Send Welcome (MailChimp settings): If your double_optin is false and this is true, MailChimp will send your lists Welcome Email if this subscribe succeeds - this will *not* fire if we end up updating an existing subscriber. If double_optin is true, this has no effect.
- Mailchimp List ID (MailChimp settings): Required to pass your MailChimp List ID with mailchimp or mixed mode. This gives an ability to use multiple lists on different pages. See the MailChimp Integration section to create MailChimp API Key and List ID
- Cookie Days (tracking cookie lifetime in days): Specify the number of days to prevents auto open the same signup form for the same user.
- Track Forms: Enable tracking of form views when you already connected to your Google Analytics Account in the General Settings.
- Disable for Members: The form won't appear for the logged in users.
Newsletter Integration - #back to top
The plugin allow you to use more newsletter APIs, find the available options in the Additional Newsletter Integrations accordion. All field has a descriptive tooltip to help you find out your credentials.
Saved Forms #back to top
Find the list of your saved newsletter forms on the Saved Forms page. This page display the most important details of your forms in an organized view. It is allow to edit, delete or duplicate the forms.
Also display the ID of each forms, that can help you to specify the form ID when using it via shortcode.
Subscribers #back to top
Find your subscribers in the list. You can simply export to CSV, Excel, PDF or to the Clipboard with the Copy button. With Print button, it is possible to view the list on a blank page to help printing out the subscribers list.
DELETE ALL SUBSCRIBERS means all entries will be deleted from the database, you can keep the subscriptions from the last 30days with the DELETE SUBSCRIBERS button.
Stats #back to top
The Stats provides the tracking of your signup forms and helps you to improve them regarding to the numbers.
The following screenshot made without Google Analytics integration, but these informations can be extended with more datas if you connect to your Google Analytics Account in the General Settings. (like Form Views, Unique Form Views)
General Settings #back to top
General settings section provides an option to Keep Settings, therefore you won't lose the plugin datas when deleting from your website. It can be useful when you update it to a new version.
With Enable Stats the plugin will save the subscriptions and create a statistics for you. These informations can be extended with additional informations with connecting to your Google Analytics Account. The plugin doesn't include the Google Analytics Tracking Code, you can use any free third party plugin for this.
- Minify Scripts: By default, the plugin using the minified JavaScript files. Some WEB Hosting automatically minify scipts, then it will be minified twice, that can causing issues. In this case you can set this option to OFF to use the original, unpacked files.
- Initialize plugin: Set the initialization hook for the plugin. Some Themes doesn't have a valid footer or header, in this case you can use 'when print the content' option, that works well in all cases.
Custom CSS #back to top
Save your custom CSS code into the textarea to apply any custom style definitions.
As the placeholder show you the example, it needs to specify the class or ID and the attibutes. The plugin automatically implement it to the header of the website.
Update #back to top
There are several ways to update the plugin, read the detailed informations about the process below.
Update via the built-in Updater - #back to top
Download the new version ZIP file, then browse it from your computer. It needs to be the valid plugin ZIP file, therefore pay attention to use the appropriate file, otherwise the updater will be unable to update the plugin. Click on the Update button, that will show you the changelog, including the latest changes. Click on the Start Update button to finish the process.
Update via the WordPress Installer - #back to top
Set the Keep Settings option to ON in the General Settings. Deactivate and delete the plugin, then install the new version. This method will also keep all of your forms and configuration.
Update via FTP - #back to top
Overwrite the plugin files in your WordPress installation folder (wp-content/plugins) via FTP, then deactivate and activate back the plugin. The last step is required to apply all new changes that might provided with the new plugin version.
MailChimp Integration #back to top
Visit http://mailchimp.com and click on the Sign Up Free button on the right-top of the screen. Fill with your informations then activate your registration if needed and login on: https://login.mailchimp.com
Login
Log in to the Administration area of your MailChimp Account.
Select Lists
After a successful login, you will be redirected to your Dashboard, click on the Lists menu.
Create List
Choose the Create List on the top-right.
Select Settings
Click on the List name & Defaults in the Settings menu and you will see your list ID.
Copy List ID
You have to use this ID to connect MailChimper PRO to MailChimp. Copy the List ID and paste to the MailChimp Listid field in the plugin form edit screen.
Select API Keys
We almost finished, visit your Account page on this link: https://us3.admin.mailchimp.com/account/ and click on the Extras followed by the API Keys menu. Scroll down and click on the Create A Key button.
Create A Key
Scroll down and click on the Create A Key button.
Copy the API Key
Select the API Key and copy to the clipboard.
Paste the List ID
Paste the List ID to the MailChimp Listid field in the plugin form edit screen.
Paste the API Key
Paste the API Key to the MailChimp API Key field in the plugin form edit screen.
Additional Options #back to top
Display the Signup Form on the specified page
If you decided to include the shortcode manually without the Shortcode Manager, then you can find the simple shortcode on the admin, look like: [ssp id=121234344]
If you use this shortcode, this will include the selected Signup Form only on that page, where you inserted the shortcode. Don't forget to set off the Global Signup Form checkbox in the form settings.
Embed the Form
Use the Shortcode Manager in the WYSWYG Editor to include the embed version of the shortcode or simply add it manually to any of your pages or posts:
[ssp id=121234344 embed="true" width="100%"]
Open with Link
First of all, turn on the Enable Open with Link and disable Auto Open checkboxes in the signup form visual builder settings page.
Then add the link and the shortcode to your page / post or text widget with the form id in the classname:
<a href="#" class="opensspopup-1920062782">Open Signup Form</a>
Insert the shortcode: [ssp id=1920062782]
That's all, it is simple as you see. It is also possible to control the form with the AutoOpen and Display at bottom checkboxes.
Adding image to the header
You can add images to the header, content and bottom line areas with simple HTML. Specify the image in the title setting:
Also possible to add any HTML to the content this way:
How to add YouTube video
Use the YouTube integration accordion:
Alternative Way
You can add YouTube video to the title or content part. The process the same as mentioned before with images, but you have to use iframe:
<iframe width='420' class='customplayer' height='225' src='http://www.youtube.com/embed/bncTg5ejX4g?autoplay=1&showinfo=0&controls=0' frameborder='0' allowfullscreen></iframe>
Shortcodes #back to top
Shortcode Manager
Most of the shortcodes are available in the Shortcode Manager, find it in the WYSIWYG Editor of any of your posts or pages (edit or add screen).
Select the form name from the dropdown list, then you will see a popup window that allows to customize the shortcode.
After you set the desired options and clicked on the OK button, you will get the shortcode included. At this stage, you can also make some additional customization on the shortcode with the text editor.
Deafult Shortcode
Use the shortcodes to display the form on a specified page / post. First of all, find the form ID in the form settings page.
Default Shortcode:
[ssp id="821776765"]
The default shortcode can be extended with additional parameters.
Embed Mode
Copy the shortcode to your page / post, then add embed="true".
Default Shortcode to Embed the Form:
[ssp id="821776765" embed="true" visible="true"]
The visible parameter control the visibility of the form. With false value, it will be displayed only, when the user scroll down to the place of the shortcode.
Set Custom Width
Add percentage value to the width attribute to set custom width.
Shortcode:
[ssp id="821776765" width="50%"]
Force Initialization
In some cases, when the theme doesn't provide a valid footer, the signup form can't initialize itself. In this case it doesn't appear, then you can force to initialize in the shortcode.
[ssp id="121234344" init="true"]
Display on any Pages
By default, the signup form appear on pages and posts only. If you would like to allows to display it on any type of page (eg.: archive, 404, etc.) just add allpage="true"
[ssp id="121234344" allpage="true"]
Animated Display
With visible="false" the signup form will appears with a smooth animation when the visitor scroll to the place of the shortcode.
[ssp id="121234344" visible="false"]
F.A.Q. #back to top
- If you using the shortcode, please set OFF the Global Signup Form checkbox in the form settings.
- Clear your cookies and turn OFF ‘Once per User’ and ‘Once per Filled Out’ checkboxes.
- If the form still doesn’t appears, check how does it work with turning ON the Global Signup Form. If it is works well, then verify the shortcode in your editor using the text view. Sometimes it contains illegal HTML tags, if you find similar unnecessary code in the shortcode, then remove it. You can also use the built-in Shortcode Manager to implement shortcodes. Search for the MailChimper PRO icon in your WYSIWYG editor.
- The plugin trying to initialize itself in the footer to avoid conflicts with other plugins. Some WordPress Theme’s doesn’t contains valid footer, therefore the initialization process stopped. You can change the initialization place of the plugin in the General Settings.
- Use the init="true" and allpage="true" attributes in the shortcode to force the initialization and display it all type of pages:
[ssp id="12345" init="true" allpage="true"]
You can update it via FTP, the WordPress default installer and the plugin's built-in updater. Read more about the update process in the Update Section.
Please unzip the downloaded file and use the second zip inside the first (next to the documentation folder) or download the Installable WordPress File Only
Support#back to top
- * Answer for questions related with the plugin
- * Answering technical questions about item’s features
- * Assistance with reported bugs and issues
- * Help with included 3rd party assets
- * Customization Services
- * Installation Services
Please remember you purchased a very affordable plugin and you don't have to pay for a full-time web design agency for the developing. Occasionally, I will help with small tweaks, but these requests will be put on a lower priority due to their nature. Support is also 100% optional and I provide it for your convenience, so please be patient, polite and respectful.
Please visit my profile page or ask question in the plugin's the comments section
- * Make sure your question is a valid Plugin Issue and not a customization request.
- * Make sure you have read through the documentation before asking support on how to accomplish a task.
- * Make sure you double checked the plugin's FAQs.
- * Try disabling the other active plugins to make sure there isn't a conflict with any other plugins. If you found a conflict this way, you can let me know.
- * If you have customized your plugin and now have an issue, back-track to make sure you didn't make a mistake. If you have made changes and can't find the issue, please provide me with your changelog.
- * Almost 80% of the time we find that the solution to people's issues can be solved with a simple "Google Search". You might want to try that before seeking support. You might be able to fix the issue yourself much quicker than I can respond to your request.
- * Make sure to state the name of the plugin you are having issues with when requesting support via CodeCanyon.
Version History ( Changelog ) #back to top
You can find the version history (changelog.txt) file in the plugin ZIP file: mailchimper-pro-[version.number].zip inside the downloaded file or you can check the changelog on the plugin's page here.
If you have any questions that are beyond the scope of this help file, please feel free to email via my user page contact form here. With more general question relating to the plugins on CodeCanyon or with this plugin, you might consider visiting the comment section of this plugin, maybe somebody also faced with the same question.
Changelog
----------------------------------------------------------------------------------------- Version 1.8.3.4 - 17/05/2022 ----------------------------------------------------------------------------------------- - code optimization ----------------------------------------------------------------------------------------- Version 1.8.3.3 - 06/08/2021 ----------------------------------------------------------------------------------------- - fixed form creation issue ----------------------------------------------------------------------------------------- Version 1.8.3.2 - 31/05/2021 ----------------------------------------------------------------------------------------- - major code optimization - updated MailChimp api to V3 - added verification for subscribed emails for MailChimp and display a message - added HTML custom field ----------------------------------------------------------------------------------------- Version 1.8.3 - 03/07/2019 ----------------------------------------------------------------------------------------- - fixed visibility issue of the General Settings page on admin ----------------------------------------------------------------------------------------- Version 1.8.2 - 24/03/2019 ----------------------------------------------------------------------------------------- - fixed bug with Google Analytics ----------------------------------------------------------------------------------------- Version 1.8.1 - 07/09/2018 ----------------------------------------------------------------------------------------- - name changed to MailChimper PRO ----------------------------------------------------------------------------------------- Version 1.8 - 25/02/2018 ----------------------------------------------------------------------------------------- - added checkbox custom field - fixed social signup issue - minor improvements ----------------------------------------------------------------------------------------- Version 1.7.9.1 ----------------------------------------------------------------------------------------- - fixed SSL issue ----------------------------------------------------------------------------------------- Version 1.7.9 ----------------------------------------------------------------------------------------- - added option to force initialization in the shortcode with init="true" - added option to display form with shortcode on all pages with allpage="true" - added Custom CSS feature - improvements on creating form - improved saved forms screen - added duplicate form feature - reconstructed documentation - minor bugfixes ----------------------------------------------------------------------------------------- Version 1.7.8 ----------------------------------------------------------------------------------------- - fixed textarea and select different font family issue ----------------------------------------------------------------------------------------- Version 1.7.7 ----------------------------------------------------------------------------------------- - fixed image upload issue - fixed display delay timer issue ----------------------------------------------------------------------------------------- Version 1.7.6 ----------------------------------------------------------------------------------------- - added option to disable the form for members ----------------------------------------------------------------------------------------- Version 1.7.5 ----------------------------------------------------------------------------------------- - added custom fields to export - export replaced with HTML5 methods ----------------------------------------------------------------------------------------- Version 1.7.4 ----------------------------------------------------------------------------------------- - fixed subscribers ordering issue - added bulk delete option to the subscribers list - fixed exporting issue ----------------------------------------------------------------------------------------- Version 1.7.3 ----------------------------------------------------------------------------------------- - fixed Campaign Monitor NAME value issue - added subscriber's IP Address and Date to the signup notification email ----------------------------------------------------------------------------------------- Version 1.7.2 ----------------------------------------------------------------------------------------- - added disable on mobile option ----------------------------------------------------------------------------------------- Version 1.7.1 ----------------------------------------------------------------------------------------- - fixed embed mode duplication issue ----------------------------------------------------------------------------------------- Version 1.7 ----------------------------------------------------------------------------------------- - fixed minor JavaScript conflict in FireFox - fixed different placeholder colors in FireFox - fixed image width in mobile view - added hidden custom field - fixed minor bugs in subscribers' view on admin - minor improvements for custom fields on frontend - fixed Safari animation issue - fixed subscribe button position issue - support WordPress Multisites - added option to set the plugin initialization hook - fixed minor issue with YouTube autoplay - minor improvements on admin - improved shortcode management - improved embed display - added option to redirect the user after a successful signup - changed manual updater to call plugin activation automatically - improved mail sending for notifications - added option to include image to the content or as background - added MailPoet API - improved background lock - fixed minor conflict with Google Analytics - display errors passed from MailChimp ----------------------------------------------------------------------------------------- Version 1.6 ----------------------------------------------------------------------------------------- - option to use packed or unpacked script on the frontend - element effects, provides 200+ animation combinations - embed style - option to add signup form shortcode to text widget - reconstructed frontend script for improving performance - option to use YouTube video as background - multiple instances - optional display animation for embed style - additional shortcode options in the shortcode manager - added WordPress Manual Updater (from ZIP) - added popup window on admin to display subscriber informations - fixed minor animation visibility issue on Internet Explorer - integrated charts to stats (Bar Chart – stats by date, Polar Chart – stats by forms, Pie Chart – stats by links) - restructured admin pages - added Google Analytics API to Stats - added Export options to Stats (Copy, CSV, Excel, PDF, Print) - added Stats by link, form and date - added Subscribers List - added YMLP API - added SimplyCast API - added Shortcode Manager to insert the plugin’s shortcodes easier - added Stats to admin - added option to enable Stats - added MyMail API - added MadMimi API - improved admin - fixed minor bugs - updated documentation ----------------------------------------------------------------------------------------- Version 1.5 ----------------------------------------------------------------------------------------- - improved styles on admin - added YouTube integration options on admin - added Active Campaign API - added Benchmark API - added Campaign Monitor API - added Campayn API - added Constant Contact API - added Freshmail API - added GetResponse API - added option to keep setting during uninstall (for update process) - improved SQL security - improved email sendings - added option to display different signup forms with shortcode for once per user and for once per signup - added YouTube video support - added automatic height detection, no longer needs to specify the overall height when you added images to the signup form - fixed minor bugs - updated documentation ----------------------------------------------------------------------------------------- Version 1.4 ----------------------------------------------------------------------------------------- - added more animation types (slide, rotate, perspective, scale) - option to add unlimited custom fields - added signup with Facebook - added signup with Google Plus - added option to set margin for custom fields - added option to disable open with link method - added option to display footer text - added option to set border radius - added option to hide signup form for already signed up users - added option to enable or disable form closing with clicking on the background layer - opacity setting deprecated - updated documentation - fixed jQuery conflict with jQuery Migrate Plugin - removed NameSpace avoid some PHP version conflicts ----------------------------------------------------------------------------------------- Version 1.3 ----------------------------------------------------------------------------------------- - added option to lock the screen with ability to close the popup clicking on the transparent layer - added option to hide the popup's close button (usable with lock the screen setting) - optimized form elements to avoid conflicts with other forms of the website