Version: 2.0
Release: Feb 1, 2006
Compatibility: QC v1.0+
Languages: en
Author: Wizzud
Contact: rb@wizzud.com

HTML Mail Order Details

Plugin module for Quick.Cart by OpenSolution.org

Synopsis

The HTML Mail Order Details plugin provides the ability to ...
  • Send full order details, by email, to Admin and/or Customer
  • Specify whether to use HTML format or Text-Only format emails, separately for both Admin and Customer
  • Select and configure the email program used by the web server: mail, sendmail, qmail, or smtp
This version uses the PHPmailer class to implement the sending of emails.
* Please note the Prerequisites for running this plugin. For ease of installation it is necessary to use the facilities provided by the Plugin Manager, and if this causes any problems I apologise in advance.

Compatibility

Quick.Cart versions prior to v1.0 : Not compatible.
Quick.Cart versions 1.0 upward : Compatible at the time of writing.
Other Plugins : At the time of release, this plugin is known to be compatible with the following available plugins (other than those listed as Prerequisite):
  • Product Atttributes v2.0
Any other plugins not mentioned above may or may not work in conjunction with HTML Mail Order Details, but it is always worth checking their available documentation to see if they specify compatibility with this plugin.

Prerequisites

Plugin Manager v2.0+ : Uses the Plugin Manager's 'extendTplParser' class extension.
None other, assuming that the Compatibility requirements have been met, and that your web server provides a suitable mechanism for transmitting emails from your application.

Upgrade

There is no upgrade path, since this is first release available for the compatible Quick.Cart version(s).

Install

Where possible, the release folder is laid out in the correct folder structure to aid installation.
  1. Copy the entire htmlMailOrderDetails folder from the release/plugins/ folder into your Quick.Cart plugins/ folder.
  2. Copy the contents of the release/templates/ folder to your Quick.Cart templates/ folder (1 new file: htmlMailOrderDetails.tpl).
  3. Go to the Configuration - Plugins option on the Admin menu, and configure and then enable the htmlMailOrderDetails plugin.

User Guide

In the Admin control panel you can use the Plugin Manager to configure the options for sending email that suit your particular situation. Four methods of sending emails are provided, and the selection of which one best suits is down to the facilities provided by your web server, and personal choice. The necessary information for setting up any particular option should be available from your web host.
You can select to send emails to either, or both, Admin and the Customer/Client, and you can specify the type of email (ie. the format) as HTML and/or Text for each individually. Please note that this plugin does not use any of the configuration or language variables from the core Quick.Cart, so if you do not wish to receive the email notification messages from the main Quick.Cart application, you will have to disable it in the main configuration panel yourself. Note also that the subject text for the emails is held in the plugin's own language file(s), not the core Quick.Cart language file.
There are a couple of configurable options available for debugging/testing purposes, but given the multitude of problems that can occur when attempting to send emails from web applications, I cannot guarantee that the information they provide will be sufficient to enable all possible scenarios to be resolved. A lot will depend upon your web server's settings, and I recommend contacting your web host if the emails appear to be being sent by the application but are not being received by the recipient(s).

HTML Format

The body of the message for an HTML-formatted email message is the same as that produced for an order print. The differences are that full URLs are used where possible, and any JavaScript-inserted stylesheets have been replaced with the relevant HTML.

Text Format

The body of the message for a text-formatted message is derived from the HTML-format message (above). It is stripped of all JavaScript, HTML tags, and surplus white-space (except within double quotes). Some replacement of HTML entities is done, and, where possible, fields within containing TR tags are put on the same line of text.

Language

By default this plugin is only supplied with an English language file - /plugins/htmlMailOrderDetails/lang-en.php.
If you wish to provide translations for your own language, copy lang-en.php to lang-[2-char-code].php (within the same folder), where [2-char-code] is the recognised code for your language. For example, a Polish language file would be /plugins/htmlMailOrderDetails/lang-pl.php.
The Plugin Manager will automatically load the English file first, and then look for the language file in the Shop's configured language, so that the English text is always there as a backup.
~~ The End ~~