Product Release Information

Product:	Simplified Newsletter for osCommerce
Release Number:	1.0.1
Release Date:	Dec 8, 2009
Customer Support:	For more information or support, please visit our website or contact us from the online form

Introduction

This document describes how to install and get started with Simplified Newsletter Module.

Features of the Simplified Newsletter module:

• Allow website visitors subscribe to news letter with registration
• Allow admin disable/enable this module, disable/enable the subscribers
• Automatically append unsubscribe link to the foot of email content, allow subscribers unsubscribe the newsletter, once unsubscribed, no more email will be sent to the user
• Allow admin send email to all subscribers or only to subscribers in selected registration date range
• Allow admin view/edit/delete subscriber information
• Allow reuse of the existing newsletter template as the email content
• allow admin to view logs for the newsletter sent
• Easy installation, seamless integration with osCommerce

Minimal System Requirements

System requirements are described in the release notes.

Installation

What other software must be installed first?

Before you can install this product, you must obtain access to a web server with the following:

• PHP 4.x with :
• GD Library
• mCrypt
• Register Globals set to On via httpd.conf, php.ini or .htaccess
• The Apache Webserver
• MySQL database
• The Linux / Unix Operating System
• osCommerce 2.2 or later

How do I install osCommerce : Simplified Newsletter Module?

Please follow these steps:

1. Upload the files to your catalog directory on the webserver.
2. Open admin/includes/column_left.php file, after
   if (tep_admin_check_boxes('catalog.php') == true) { require(DIR_WS_BOXES . 'catalog.php'); }
   add
   if (tep_admin_check_boxes('newsletter.php') == true) { require(DIR_WS_BOXES . 'newsletter.php'); }
3. Open admin/includes/languages/english.php file, before last
   ?>
   add
   define('BOX_HEADING_NEWSLETTER', 'Newsletter'); define('TABLE_SIMPLIFIEDNEWSLETTERS', 'simplifiednewsletters'); define('TABLE_SUBSCRIBERS', 'subscribers'); define('TABLE_SIMPLIFIEDNEWSLETTERS_SENT', 'simplifiednewsletters_sent'); define('BOX_SIMPLIFIEDNEWSLETTER', 'Simplified Newsletter'); define('BOX_SIMPLIFIEDNEWSLETTER_MANAGER', 'Manager'); define('BOX_SIMPLIFIEDNEWSLETTER_SUBSCRIBER', 'Subscriber'); define('BOX_SIMPLIFIEDNEWSLETTER_REPORT', 'Sent Report');
4. Open includes/languages/english.php file, before last
   ?>
   add
   define('TABLE_SIMPLIFIEDNEWSLETTERS', 'simplifiednewsletters'); define('TABLE_SUBSCRIBERS', 'subscribers'); define('TABLE_SIMPLIFIEDNEWSLETTERS_SENT', 'simplifiednewsletters_sent'); define('IMAGE_BUTTON_SUBMIT', 'Submit'); define('TEXT_SIMPLIFIEDNEWSLETTER_FIRSTNAME', 'First Name: '); define('TEXT_SIMPLIFIEDNEWSLETTER_EMAIL', 'Email: '); define('TEXT_SIMPLIFIEDNEWSLETTER_EMAIL_ADDRESS_ERROR', 'The Email address: %s is invalid!'); define('TEXT_SIMPLIFIEDNEWSLETTER_EMAIL_SUCCESS', 'Subscribe your account successfully!'); define('BOX_HEADING_SIMPLIFIED_NEWSLETTER', 'Newsletter');
5. Open includes/application_top.php file, before last
   ?>
   add
   if (defined('MODULE_ADDONS_SIMPLIFIEDNEWSLETTER_STATUS') && MODULE_ADDONS_SIMPLIFIEDNEWSLETTER_STATUS == 'True') { if (isset($_POST['simplified_newsletter_email_address']) && $_POST['simplified_newsletter_email_address'] != '') { $email_address = trim($_POST['simplified_newsletter_email_address']); if (!preg_match('/[a-zA-Z0-9._%-]+@[a-zA-Z0-9._%-]+\.[a-zA-Z]{2,4}/', $email_address)) { $simplified_news_js_hint = sprintf(TEXT_SIMPLIFIEDNEWSLETTER_EMAIL_ADDRESS_ERROR, $email_address); return; } $exclude = array('first_name', 'simplified_newsletter_email_address', 'x', 'y'); $extra_html = ''; foreach ($_POST as $key => $value) { if (!in_array($key, $exclude)) { $extra_html .= urlencode($key) . '=' . urlencode($value) . '&'; } } if ($extra_html != '') { $extra_html = substr($extra_html, 0, strlen($extra_html) - 1); } $check_customer_query_val = tep_db_query("select email_address from " . TABLE_SUBSCRIBERS . " where email_address = '" . tep_db_input($email_address) . "'"); if (tep_db_num_rows($check_customer_query_val) > 0) { tep_db_query("update " . TABLE_SUBSCRIBERS . " set first_name = '" . tep_db_input($_POST['first_name']) . "', extra_html = '" . $extra_html . "', subscribers_status = 1, date_modified = now(), ip_address = '" . $_SERVER['REMOTE_ADDR'] . "' where email_address = '" . tep_db_input($email_address) . "'"); } else { tep_db_query("insert into " . TABLE_SUBSCRIBERS . " (first_name, email_address, extra_html, ip_address, date_added, date_modified, subscribers_status) values('" . tep_db_input($_POST['first_name']) . "', '" . tep_db_input($email_address) . "', '" . $extra_html . "', '" . $_SERVER['REMOTE_ADDR'] . "', now(), now(), 1)"); } $simplified_news_js_hint = TEXT_SIMPLIFIEDNEWSLETTER_EMAIL_SUCCESS; } }
6. Open includes/application_top.php file, before last
   ?>
   add
   require(DIR_WS_BOXES . 'simplified_newsletter.php');
7. Run SQL statement in phpMyAdmin:
   CREATE TABLE simplifiednewsletters (id int(11) NOT NULL AUTO_INCREMENT, title varchar(255) NOT NULL DEFAULT '', content text NOT NULL, date_added datetime NOT NULL DEFAULT '0000-00-00 00:00:00', newsletter_status tinyint(1) NOT NULL DEFAULT '0', PRIMARY KEY (id)); CREATE TABLE subscribers (id int(11) NOT NULL AUTO_INCREMENT, first_name varchar(255) NOT NULL DEFAULT '', last_name varchar(255) NOT NULL DEFAULT '', email_address varchar(255) NOT NULL DEFAULT '', extra_html text NOT NULL, ip_address varchar(32) NOT NULL DEFAULT '', date_added datetime NOT NULL DEFAULT '0000-00-00 00:00:00', date_modified datetime NOT NULL DEFAULT '0000-00-00 00:00:00', subscribers_status tinyint(1) NOT NULL DEFAULT '0', PRIMARY KEY (id), KEY email_address (email_address)); CREATE TABLE simplifiednewsletters_sent (id int(11) NOT NULL AUTO_INCREMENT, newsletters_id int(11) NOT NULL DEFAULT '0', subscribers_id int(11) NOT NULL DEFAULT '0', seq_id int(11) NOT NULL DEFAULT '0', date_sent datetime NOT NULL DEFAULT '0000-00-00 00:00:00', PRIMARY KEY (id), KEY seq_id (seq_id)); INSERT INTO configuration (configuration_title, configuration_key, configuration_value, configuration_description, configuration_group_id, sort_order, set_function, date_added) VALUES ('Enable Simplified Newsletter Module', 'MODULE_ADDONS_SIMPLIFIEDNEWSLETTER_STATUS', 'True', 'Select True to enable Simplified Newsletter.', '120', '10', 'tep_cfg_select_option(array(\'True\', \'False\'), ', now()); INSERT INTO configuration (configuration_title, configuration_key, configuration_value, configuration_description, configuration_group_id, sort_order, set_function, date_added) VALUES ('Extra HTML', 'MODULE_ADDONS_SIMPLIFIEDNEWSLETTER_EXTRA_HTML', '', 'Extra HTML code for subscribers register.', '120', '20', 'tep_cfg_textarea(', now()); INSERT INTO configuration_group (configuration_group_id, configuration_group_title, sort_order, visible) VALUES (120, 'Simplified Newsletter', 119, 1);
8. Go to Admin -> Administrator -> File Access, enable "Newsletter" admin box, add simplified_newsletters_*.php file to this box
9. You will find there is a new menu at Admin: Newsletter

How can I uninstall osCommerce Loaded : Simplified Newsletter Module?

    Delete all files that you added

    Restore all files that you changed

    Run SQL statement in phpMyAdmin:
         delete from configuration where configuration_key in ('MODULE_ADDONS_SIMPLIFIEDNEWSLETTER_STATUS', 'MODULE_ADDONS_SIMPLIFIEDNEWSLETTER_EXTRA_HTML'); drop table simplifiednewsletters; drop table subscribers; drop table simplifiednewsletters_sent;

What if I encounter problems?

    Please see the troubleshooting section in the FAQ.