Created : 15 April 2015
Last Modified : 30 Aug 2019

***********************************************************************************
Contents:

A. SUMMARY
B. FILE STRUCTURE
C. INSTALLATION INSTRUCTION
D. CHANGES
E. CONFIGURATION SETTINGS
F. DATABASE TABLES MODIFIED
G. LANGUAGE SETTINGS CHANGED
H. CHANGE LOGS
I. TROUBLESHOOTING
J. FAQ
K. COPYRIGHT NOTICE
L. TERMS AND CONDITIONS

***********************************************************************************

A. SUMMARY
==========

Allow to use the following Newsletter subscribe system for the site.

1. Campaign monitor Newsletter
2. Mailchimp Newsletter

***********************************************************************************

B. FILE STRUCTURE
===================

Files included in the zip are:
- $READ_ME_FIRST_newsletter900.HTML
- plugins\newsletter\newsletter.js
- shoplayoutmgrnewsletter.asp
- shopnewsletter_base64hash.asp
- shopnewsletter_cart_subs.asp
- shopnewsletter_cm_include.asp
- shopnewsletter_mailchimp_include.asp
- shopnewsletter_subs.asp
- shopnewsletter_subscribe.asp
- shopnewsletter_unsubscribe.asp
- admin\shopa_layoutmgrnewsletter_subs.asp
- admin\newsletter_setup.asp
- admin\newsletter_setup_config.asp
- admin\newsletter_setup_process.asp
- admin\sqlscripts\newsletter\*

***********************************************************************************

C. INSTALLATION INSTRUCTION
============================

1. Backup your site files below:
- plugins\newsletter\newsletter.js
- shoplayoutmgrnewsletter.asp
- shopnewsletter_cart_subs.asp
- shopnewsletter_cm_include.asp
- shopnewsletter_mailchimp_include.asp
- shopnewsletter_subs.asp
- shopnewsletter_subscribe.asp
- shopnewsletter_unsubscribe.asp
- admin\shopa_layoutmgrnewsletter_subs.asp

2. Upload all the files below into your shopping cart folder:
- plugins\newsletter\newsletter.js
- shoplayoutmgrnewsletter.asp
- shopnewsletter_base64hash.asp
- shopnewsletter_cart_subs.asp
- shopnewsletter_cm_include.asp
- shopnewsletter_mailchimp_include.asp
- shopnewsletter_subs.asp
- shopnewsletter_subscribe.asp
- shopnewsletter_unsubscribe.asp
- admin\shopa_layoutmgrnewsletter_subs.asp
- admin\newsletter_setup.asp
- admin\newsletter_setup_config.asp
- admin\newsletter_setup_process.asp
- admin\sqlscripts\newsletter\*

3. Log into super admin and execute setup file, eg: http://www.yourdomain.com/yourshoppingcartfolder/youradminfolder/newsletter_setup.asp

4. After setup the module, would be redirected Module configuration page for configure the module

5. To enable this module, please set "Enable" to Yes.

6. You will have two options to enable which email marketing platform you want to use.
VPCart Newsletter module provides you with "Campaign Monitor" and also "MailChimp" ability.

USING CAMPAIGN MONITOR:

6.A) If you want to use Campaign Monitor, then please enter the below fields:
(Note: You must already have Campaign Monitor account to use this. If you do not have account, please register an account at
https://www.campaignmonitor.com)

CM: Enable?: Yes
CM: API Key: Enter your Campaign Monitor API Key. To get your API Key, please refer to https://help.campaignmonitor.com/api-keys
CM: Subcriber List ID: Enter the Subscriber List ID.

You can find your API Subscriber List ID by:
a. Log in to your account at https://login.createsend.com/l
b. In the left panel of Your Clients, click the client account you are setting up the module for.
c. Once the client has been selected, go to the Lists & Subscribers tab
d. Click on the List you are setting up the module for. You may need to create a Subscriber list first if you do not have one listed.
e. Click Change name/type link.
f. Locate for API Subscriber List ID for the list id. It should be something like eg 43b9af01e802a6155e4fabc79b7xxxx

USING MAILCHIMP:

6.B) If you want to use MailChimp, then please follow our helpnote below on how to enable MailChimp and how to enter the MailChimp account details:
https://helpnotes.vpcart.com/kb/55-Mailing-to-Multiple-People/1191-How-to-install-MailChimp-newsletter-into-your-VPCart-site/

(Note: You must already have MailChimp account to use this. If you do not have account, please register an account at mailchimp.com. Also, MailChimp charges for sending emails however if you have less than 2,000 subscribers you can send up to 12,000 emails a month free. For pricing above 2,000 subscribers please go to MailChimp Pricing.)

7. To add newsletter box in front site, Go to Website > Layout Manager, then Add Box (eg. in Left/Right Container), make sure you enter the config below:
Main Selector : Column Newsletter
Enable : Yes

Enter other config as you want, click Save Changes button after done


***********************************************************************************

D. CHANGES
===============

'2020.03.11 - Newsletter: use unique routine name to avoid conflict

***********************************************************************************

E. CONFIGURATION SETTINGS
=================

NONE


F. DATABASE TABLES MODIFIED
===========================

NONE

***********************************************************************************

G. LANGUAGE SETTINGS CHANGED
============================

NONE

***********************************************************************************

H. CHANGE LOGS
============================

2016.02.25 - XML: To support TLS1.2
2016.02.26 - MySQL: Always to set cursorlocation as 3 if retrieve recordcount
Enhancement: Newsletter: Include to Footer left, right and center (only work with V8.1.0.1 or leter)
Enhancement: Newsletter: Include title to footer
2016.05.27 - Async JS
2016.06.14 - Fix for doxml_mailchimp routine in shopnewsletter_mailchimp_include.asp
2016.09.23 - Change mailchimp API 1.3 to API 3.0
2016.12.15 - Latest changes make error on product description page
2017.07.12 - Not able to work with MySQL database
2017.11.29 - Bug Fix: MailChimp: Not able to subscribe new email
2017.11.29 - Bug Fix: MailChimp: Better error description
2018.03.07 - To have unique hash variable name to avoid conflict other modules
2018.03.22 - Newsletter throwing error if TLS patched is applied on the site
2018.04.20 - Compatible with v9
2018.08.30 - Enhancement: Removed shopnewsletter_aspJSON1.17.asp file
2018.10.19 - Not able to work with MySQL database'2019.08.30 - Bug Fix: Possible error on the site if Newsletter and Authnet Accepthosted or AcceptJS installed on same site

***********************************************************************************

I. TROUBLESHOOTING
============================

Please submit a ticket to our helpdesk at https://helpdesk.vpcart.com and our support team will assist you.

***********************************************************************************

J. FAQ
============================

NONE

***********************************************************************************
K. COPYRIGHT NOTICE
============================

Copyright (c) 1999-2019 Rocksalt International Pty. Ltd.
All rights reserved.

This software and documentation constitute a published work and
contains valuable trade secrets and proprietary information
belonging to Rocksalt International Pty. Ltd. .
None of the foregoing material may be copied,
duplicated or disclosed without the express written permission
of Rocksalt International Pty. Ltd. .

LICENSEE ACCEPTS VP-ASP Shopping Cart "AS IS" "WITH ALL FAULTS",
Rocksalt International Pty. Ltd. accepts no responsibility for the
operation or performance of the VP-ASP Shopping Cart.
The entire risk of use and consequences of use of the
VP-ASP Shopping Cart falls completely on the Licensee
and Rocksalt International Pty. Ltd. shall not be liable in any respect
for any claims, loss or injury alleged to have resulted
from use of or in reliance on VP-ASP Shopping Cart.

Licensee acknowledges that it has read the foregoing
disclaimers of warranty and limitation of liability
and understands that Licensee assumes
the entire risk of using VP-ASP Shopping Cart.


***********************************************************************************

L. TERMS AND CONDITIONS
============================
ROCKSALT INTERNATIONAL GRANTS TO THE LICENSEE A NON-EXCLUSIVE,
NON-SUB LICENSABLE, NONTRANSFERABLE LICENSE
TO INSTALL AND USE THIS APPLICATION ON A SINGLE DOMAIN FOR
A SINGLE SHOP.

THE CODE IN THE APPLICATION MAY BE MODIFIED FOR USE IN
SETTING UP A SINGLE SHOPPING SITE ON THE WORLD WIDE WEB.

LICENSEE MAY MAKE A COPY OF THE APPLICATION FOR
BACK-UP AND ARCHIVAL PURPOSES, PROVIDED THAT ANY COPY
MUST CONTAIN ALL PROPRIETARY NOTICES INCLUDED
WITH THE APPLICATION.

LICENSEE IS PROHIBITED FROM SELLING OR DISTRIBUTING
THE APPLICATION IN ANY MANNER.

LIMITATION OF LIABILITY.

ROCKSALT INTERNATIONAL AND ITS LICENSORS SHALL
NOT BE LIABLE FOR ANY DAMAGES SUFFERED BY LICENSEE OR ANY
THIRD PARTY AS A RESULT OF USING OR DISTRIBUTING THIS
APPLICATION.

IN NO EVENT WILL ROCKSALT INTERNATIONAL OR ITS LICENSORS
BE LIABLE FOR ANY LOST REVENUE, PROFIT OR DATA,
OR FOR DIRECT, INDIRECT, SPECIAL,
CONSEQUENTIAL, INCIDENTAL OR PUNITIVE DAMAGES,
HOWEVER CAUSED AND REGARDLESS OF THE THEORY OF LI
ARISING OUT OF THE USE OF OR INABILITY TO USE THE SOFTWARE,
EVEN IF ROCKSALT INTERNATIONAL HAS BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES.