Installation, Upgrade, Uninstall & Release Notes
We have choosen the manual approach for installation of this Magento Extension, to give everyone also the freedom to look inside of the package before installation. Also if the extensions is active in a production environment, any automated update may interfere with the store functionality.
1. Prerequisites
- Magento 1.3.x and all prerequisites coming with it.
- Your Magento installation is required to be faultless and fully functional.
- We strongly recommend to perform the first install on a non-productive system, to perform your settings and any customizations there first. And then to install the extension on your production system with transfering your settings and customization.
2. Installation
- Take your Magento Shop offline in case you are installing on your Production System. In case during installation your Magento Store is activated the installation may become incomplete and error messages or malfunctions may result.
- Unpack the contents of the package and copy the content into the home directory of your Magento installation on your server:
The Installation Package contains a directory structure that already holdes the individual files correct positions, and that is relative to the Magento Store's home directory (or installation path) on your server.
If your Magento Store is installed in/home/www/magento
then your home directory is to show aapp
subdirectory (as in the installation package).
Extract the content of the Archive (or upload its content) into the home directory of your Magento Store, the head subdirectories of the Installation Package shall match the subdirectory structure of the home directory (as a check).
- If you are using Caching in your Magento Store, login into your Magento Administration and refresh your Cache:
System
»Cache Management
»All Cache
»Refresh
. - Read through here for the initial configuration of your Magento Store to work with SmtpPlus.
Related Links
3. Upgrades
- Take your Magento Shop offline in case you are upgrading your Production System. In case during upgrade your Magento Store is activated the upgrade may become incomplete and error messages or malfunctions may result.
- Backup your Magento installation, or at least backup the folder
app/code/local/Pisc/Smtpplus
for saving any current installed version of SmtpPlus. - Delete the folder
app/code/local/Pisc/Smtpplus
to ensure correct updating of store resources required by the extension. - Unpack the contents of the package and upload the content into the home directory of your Magento installation on your server.
- Alternatively you may just unpack the files in
app/code/local/Pisc/Smtpplus
andapp/etc/modules
for the main extension files, and update any template related files later manually. - If you are using Caching in your Magento Store, login into your Magento Administration and refresh your Cache:
System
»Cache Management
»All Cache
»Refresh
.
4. Uninstall
To uninstall SmtpPlus from your Store follow this procedure:
- You may want to take your Store offline, be aware that removing SmtpPlus from a Store in operation may generate errors.
- Remove the extension definition file
/app/etc/modules/Pisc_Smtpplus.xml
- Update your Stores Cache using the Administrator and
System
»Cache Management
»All Cache
»Refresh
- Remove the directory
app/code/local/Pisc/Smtpplus
- Remove the Version entry for SmtpPlus in the Magento Database by opening the table
core_resource
and removing the row entry forsmtpplus_setup
.
This table name may carry the table prefix defined for your Magento installation.
5. Manually create Database Tables
In the rare event that Magento was unable to create the Database Tables for SmtpPlus by the automated setup itself, here are the SQL Commands to create these Database Tables manually.
mage_
).In case such Table Prefix is used in your Magento Database, prefix the table names with the same Table Prefix (in our example:
smtpplus_email_log
will get mage_smtpplus_email_log
).
Database Table 'smtpplus_email_log'
DROP TABLE IF EXISTS `smtpplus_email_log`; CREATE TABLE IF NOT EXISTS `smtpplus_email_log` ( `id` INT(11) NOT NULL AUTO_INCREMENT, `customer_id` INT(11) DEFAULT NULL, `address_to` tinytext DEFAULT NULL, `address_from` tinytext, `subject` tinytext, `body_html` mediumtext, `body_text` mediumtext, `date_sent` datetime DEFAULT NULL, `exception_message` mediumtext, PRIMARY KEY (`id`) ) ENGINE=InnoDB DEFAULT CHARSET=utf8 COMMENT='SmtpPlus Email Log';
6. Release Notes
Get Updates
Updates to all of your purchased Commercial Unlimited Licenses are available for Download in your Store Account:
Update to 0.1.6
This is a maintenance release addressing a possible issue occurring when sending newsletters and the default Magento email transport for the individual newsletters is used instead of the SmtpPlus functions.
Update to 0.1.5
This is a general maintenance release correcting minor issues reported from users.
Update to 0.1.4
This maintenance release is addressing a minor issue that may occur when using a customer Administrator URL where the 'Back' buttons do not redirect correctly.
Additionally the default template for the New Email Message is now also included in German. When deleting a customer account, all related stored Email Messages will get deleted as well.
Update to 0.1.3
This release is addressing a issue where the content of a New Email Message being sent from the Customer Account may not be transferred from the form to the message. That may get caused if a WYSIWYG Editor is installed, and that Editor is not fully configured to replace the default text-area in the New Email Message form.
Update to 0.1.2
This release corrects a issue where a New Email Message is not being sent from the Customer Account, when having a non-default Administrator URL and the Secure Key enabled in the Administrator URL.
Installation of 0.1.1
This is the initinal release of SmtpPlus for Magento.