VP Email Manager User Guide

VP Email Manager is an Email Manager extension for VirtueMart. You can add customised email templates for all emails sent by VirtueMart. You can also set separate email templates based on selected products, categories, manufacturers, vendors, countries, states, users etc. All email sent by the system are saved in Outbox which can be reviewed anytime after the emails are sent.

Installation

You can download the latest installation packages from our site's download page for VP Email Manager. If you have an older version of Joomla! or VirtueMart or PHP please check the compatibility section to find the version of VP Email Manager compatible with your Joomla!, VirtueMart and PHP versions.

All VP Email Manager installation packages contain the component and all of its associated plugins. Installing it will install all of these items automatically. It can also be used to upgrade/update VP Email Manager; just install it without uninstalling the previous release.

Uninstallation

You can uninstall the extension just like any other Joomla! extension. In your site's back-end, just go to Extensions Manager, click on Uninstall, select VP Email Manager Package and click on Uninstall. This will completely remove VP Email Manager package including all plugins and database information.

Configuration

General

VP Email Manager - General Configuration
Enable VP Email Manager

If yes, VP Email Manager is used to send VirtueMart emails. If no, all VirtueMart emails are sent through standard VirtueMart system.

Fallback

Select an alternative if no events match with the email being sent. If Use VirtueMart Core, core VirtueMart emails will be sent. If disable, no emails will be sent.

Pending Order Status

Select the pending order statuses.

Confirmed Order Status

Select the confirmed order statuses.

Preview

VP Email Manager - Preview Configuration
Preview Order

Select an order which will be used for template preview.

Preview Product

Select a product which will be used for template preview.

Preview User

Select an user which will be used for template preview.

Order Items Table

Fine tune the display of order items table in emails.

VP Email Manager - Order Items Table Configuration
Show Prices

If yes, prices are displayed.

Show Tax

If yes, taxes are displayed.

Show Discount

If yes, discounts are displayed.

Show SKU

If yes, SKU is displayed.

Show Item Order Status

If yes, item order statuses are displayed.

Show Quantity

If yes, item order quantities are displayed.

Live Update

Add your Download Key to receive live updates.

VP Email Manager - Live Update Configuration
Download Key

Add your VirtuePlanet Download Key to receive live updates.

Events

Events allow you to set separate templates for selected products, categories, manufacturers, users, shopper groups, countries and order statuses. You can also set cc, bcc and other email settings in events.

VP Email Manager - Events VP Email Manager - Events
Name

Enter an unique and recongizable name for the event.

Type

Select the desired mail type. Available options are given below:

  1. User - Order confirmation
  2. User - Order Status Change
  3. User - Registration
  4. User - Product Back In Stock
  5. User - Product Recommendation
  6. Admin - Order Confirmation
  7. Admin - Order Status Change
  8. Admin - Registration
  9. Admin - Ask a Question about Product
Template

Select the desired email template from the drop down list.

To

This option is only available for Admin emails. Enter the email address to which the email will be sent. If empty, the emails will be sent to the vendor's email address.

CC

Enter the email address to which the email will be copied to.

BCC

Enter the email address to which the email will be copied to as BCC.

From Email

Enter the desired from email address. By default, it will use the from email address from Joomla Global Configuration.

From Name

Enter the desired from name. By default, it will use the from name from Joomla Global Configuration.

Reply To Email

This option is only available for User emails. Enter your desired reply to email address. If blank, default reply to address from VirtueMart system will be used.

Reply To Name

This option is only available for User emails. Enter your desired reply to name. If blank, default reply to name from VirtueMart system will be used.

Conditions

Vendor

Select the desired vendors from the drop down list.

Vendor Operator

Select the desired operator for selected vendors. If include, the event will get triggered only for the selected vendors. If exclude, the event will not get triggered for the selected vendors.

Product

Select the desired products from the drop down list.

Product Operator

Select the desired operator for selected products. If include, the event will get triggered only for the selected products. If exclude, the event will not get triggered for the selected products.

Category

Select the desired categories from the drop down list.

Category Operator

Select the desired operator for selected categories. If include, the event will get triggered only for the selected categories. If exclude, the event will not get triggered for the selected categories.

Manufacturer

Select the desired manufacturers from the drop down list.

Manufacturer Operator

Select the desired operator for selected manufacturers. If include, the event will get triggered only for the selected manufacturers. If exclude, the event will not get triggered for the selected manufacturers.

Guests Only

If yes, the event will be only triggered for guest users.

User

Select the desired users from the drop down list.

User Operator

Select the desired operator for selected users. If include, the event will get triggered only for the selected users. If exclude, the event will not get triggered for the selected users.

Shopper Group

Select the desired shopper groups from the drop down list.

Shopper Group Operator

Select the desired operator for selected shopper groups. If include, the event will get triggered only for the selected shopper groups. If exclude, the event will not get triggered for the selected shopper groups.

Billing Country

Select the desired billing countries from the drop down list.

Billing Country Operator

Select the desired operator for selected billing countries. If include, the event will get triggered only for the selected billing countries. If exclude, the event will not get triggered for the selected billing countries.

Shipping Country

Select the desired shipping countries from the drop down list.

Shipping Country Operator

Select the desired operator for selected shipping countries. If include, the event will get triggered only for the selected shipping countries. If exclude, the event will not get triggered for the selected shipping countries.

Order Status

Select the desired order statuses from the drop down list.

Order Status Operator

Select the desired operator for selected order statuses. If include, the event will get triggered only for the selected order statuses. If exclude, the event will not get triggered for the selected order statuses.

Language

Select desired language for the event. If all, the event will get triggered for all languages.

Templates

You can add/manage the email templates in this section. The templates use Moustache template engine. This allows you to easily utilize data variables in the email subject and email body. You can also make use of many other available functions in the emails. eg. {{# JText._ }}LANGUAGE_STRING{{/ JText._ }}

You can always see the preview of the mail by clicking on the Preview button located at the top of the template edit page. Do remember to save your changes first before Previewing the template.

VP Email Manager - Templates VP Email Manager - Template
Name

Give an unique and recongizable name for the template.

Type

Select the desired mail type. Available options are given below:

  1. User - Order confirmation
  2. User - Order Status Change
  3. User - Registration
  4. User - Product Back In Stock
  5. User - Product Recommendation
  6. Admin - Order Confirmation
  7. Admin - Order Status Change
  8. Admin - Registration
  9. Admin - Ask a Question about Product
Subject

Enter the subject of the email. You can also use data variables and function in the subject. List of available variables and functions can be found at the right side of the page.

Body

Enter the HTML body of the email. You can also use data variables and function in the subject. List of available variables and functions can be found at the right side of the page.

CSS Style

You can add css styles in this section which needs to be included in the email. CSS styles can be very useful while designing responsive email templates.

Variables and Functions

The email type specific variables and functions are listed at the right side of the template edit page. You can easily copy and make use of them in the email subject & in the body as per your requirements.

Outbox

All emails sent by the VP Email Manager are saved and can be reviewed in Outbox at any point of time. You can also see the status of individual mails sent.

You can also delete the unnecessary emails, if needed.

VP Email Manager - Outbox VP Email Manager - Mails