Child pages
  • Follow Up Email - Magento 2

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Section
Column
width50%

Table of Contents

Warning

Firefox user notice:

Please use different web browser to view this document.

Sorry for the inconvenience.

Column
width30%

Follow Up Email - Magento 2

Magento 2 Follow Up Email allows organizing targeted email campaigns with highly customizable content. Web store owners can define when emails should be sent by choosing among five trigger events available. For more precise timing of each email, the module provides the email scheduling feature.By viewing email stats, merchants can evaluate the efficiency of individual campaigns and timely implement the necessary corrections to them. 

UI Button
titleProduct Page
colororange
urlhttps://ecommerce.aheadworks.com/magento-2-extensions/follow-up-email/
sizelarge

Thank you for choosing Aheadworks!

 


Installing Follow Up Email

 

To install the extension follow the instructions below:

Section
Column
width50%

Command Line Installation

Panel
borderStylesolid
borderWidth2px

1. Backup your web directory and store database

Panel
borderStylesolid
borderWidth2px

2. Download Follow Up Email installation package

Panel
borderStylesolid
borderWidth2px

 3. Upload contents of the Follow Up Email installation package to your store root directory

Panel
borderStylesolid
borderWidth2px

 4. In SSH console of your server navigate to your store root folder:

No Format
cd path_to_the_store_root_folder

run:

No Format
php -f bin/magento module:enable Aheadworks_Followupemail

then:

No Format
php -f bin/magento setup:upgrade

after:

No Format
php -f bin/magento setup:static-content:deploy
Panel
borderStylesolid
borderWidth2px

5. Flush store cache; log out from the backend and log in again

Note

Make sure the installation is done from under the FTP administrator account. Otherwise make sure to set 775 permissions to the store root directory after the extension is deployed.

Column
width50%

Composer Installation

Panel
borderStylesolid
borderWidth2px

1. Log in to your customer account at https://ecommerce.aheadworks.com and navigate to Account -> Composer access;

Panel
borderStylesolid
borderWidth2px

2. Configure your store to work with the Aheadworks composer repository:

Add composer repository to composer.json by running:

composer config repositories.aheadworks composer https://dist.aheadworks.com/ in the Magento installation root.

Use a key pair provided as login and pass. You can optionally save them in the global composer auth file.

Panel
borderStylesolid
borderWidth2px

 3. You can start using AW composer now.

 For extension names, navigate to Account -> Composer access.

Panel
borderStylesolid
borderWidth2px

 4. Open the root Magento directory on your server and send Composer the following command:

composer require <component-name>:<version>

Note: Use the previously copied component name and version.

Panel
borderStylesolid
borderWidth2px

 5. Make sure that Composer finished the installation without errors. Flush store cache, log out and log into the backend again.

 

Set up cron

 

Section
Column
width50%

If you have already configured cron jobs for your Magento installation then you can skip this step. Read the following instructions on setting cron job for your Magento store: Magento user guide.

Generally it would be enough to run in SSH console of your server: 

 

Code Block
languagebash
crontab -e

 

And insert the following line:  

 

Code Block
*/3 * * * * php -c <ini-file-path> <your Magento install dir>/bin/magento cron:run
*/3 * * * * php -c <ini-file-path> <your Magento install dir>/update/cron.php
*/3 * * * * php -c <ini-file-path> <your Magento install dir>/bin/magento setup:cron:run

 

Don't forget to confirm saving request when exit.

Column
width50%

 

 


Introducing Follow Up Email

 

Section

Follow Up Email extension is a smart email marketing solution that sends emails based on customers’ activity at the store:

  • Abandoned checkout;
  • Order status changed;
  • Customer registration;
  • Last customer activity;
  • Customer birthday.

Follow Up Email offers five customer triggered email events for sending relevant messages ad hoc. Every event covers particular aspect of the customer’s store activity: registration, placing orders, etc.

When the event is triggered an email message is sent to the customer’s email address. You can create multiple email templates for a single event adjusting the email subject, body and signature.

Each event email can be scheduled to fire at the appropriate time. For example you may want to schedule an Abandoned Checkout email to fire 30 minutes after customer left a cart at your store, or ask customer for a product review in two weeks after an order has been shipped.

 


Reference Table

 

Section
  • Email event – the general condition under which a follow up is sent;
  • Event trigger – the action customer takes to trigger Email Event;
  • Email template – ready for deployment body of an email/follow up;
  • Follow up / Email – the message that is sent to the customer after an email event has been triggered.

 


Getting Around

 

Section

Follow Up Email comes set up and ready for work with store default values, no additional manipulations needed.

The extension introduces its pages to the Marketing section of the Magento 2 navigation menu. From here store administrator has an access to the following pages:

            • Events – main management screen of the extension with a set of email Events at the store administrator’s disposal;
            • Mail Log – a list of all the emails both sent and scheduled.

These two sections are the parts of the Follow Up Email “control center”. When the extension is properly configured all the email management takes place here.

In addition to Marketing section the extension introduces its general configuration options to Stores > Configuration > aheadWorks extensions > Follow Up Email.

In contrast to the Event section which controls when and what emails should be sent, the configuration options control basic extension aspects such as: email sender or if the extension is in the test mode.


General Configuration

 

Section

We advise starting with the extension Configuration when getting acquainted with Follow Up Email. Navigate to Store > Configuration > aheadWorks extensions > Follow Up Email

The configuration screen is split into two sections: General and Mail Log.

General section is represented with the following options:

  • Sender – here store administrator is suggested to define the email sender of all the follow ups;
  • Test Email Recipient – works in conjunction with Enable Test Mode – if latter enabled, all test emails go to this recipient;
  • Enable Test Mode – here store administrator is suggested to enable the test mode of the extension.

With the email Sender all is clear – this address will be displayed in the field ‘From:’ of all the follow ups. As for the Test Mode it works as follows:

Info

Test Mode:

Whenever customer triggers an event: abandons a cart, places an order etc.; the follow up is sent to the Test Email recipient instead of the customer. Thus store administrator can test all the follow ups created without troubling customers.

Mail Log section is represented with a single option:

  • Keep Emails For, days – here store administrator is suggested to define for how long should the extension keep the mail history.

Depending on the store owner requirements the extension offers to preserve the email history indefinitely if the ‘0’ is specified in the field.

That’s it for the extension’s general settings. One everything is set it is high time to proceed to creating the emails for the events.


Events section

 

Section

As it has been mentioned previously the Events section is a management center of the extension. Here store administrator can look through the email events available, create new or adjust existing event emails and many more.

The section is represented by the following elements:

Navigation Menu

Section

Navigation Menu represents an in-extension navigation tool. Via the Navigation Menu store administrator can proceed to the following pages:

            • Events section (the section we are currently at);
            • Mail Log;
            • General Configuration section;
            • Readme page;
            • aheadWorks help desk contact form.

The navigation menu is available through all the extension pages, except for the settings.

List of Events

List of events represents all the customer triggered events available within Follow Up Email. Each event is responsible for particular customer action at the store, which is followed up by a corresponding email.

The events come with the short description providing an insight on how does it work or what it is triggered with.

Info

Note:

The emails are NOT retroactive. Meaning emails cannot be sent for any customer activity/orders placed before the application installation.

Currently Follow Up Email offers a set of five events:

Event name

Event background

Abandoned Checkout

This Event allows sending email reminders to the customers who added any amount of products to their shopping cart and for some reason left the store without a purchase

The shopping cart is considered abandoned after an hour since the last customer's activity on the store, e.g.: clicking links, browsing;

When creating an email for Abandoned Checkout event consider the one hour delay for the shopping cart to be considered abandoned. This means that the delay after which the Abandoned Checkout email will be sent equals:

one hour + time scheduled

Order Status Changed

This event allows sending emails to the customers upon any change in the order status

Under the conditions section it is possible to define the order status(es) for the emails to fire

Last Customer Activity

This Event allows sending emails to the customers depending on their last visit to your store

This Event works for all customer activities at your store: browsing the pages, clicking the links, placing order etc.

Customer registration

This Event allows sending emails to the newly registered customers

This Event has no particular technical peculiarities one should consider before use

Customer Birthday

This Event allows sending birthday greetings to the store customers

Please pay close attention to ‘Specify when email should be sent’ setting. With this Event store administrator defines BEFORE how many days/hours/minutes of customer's birthday the Email should be sent

Create New Email menu

By clicking Create New Email button store administrator can choose from a list of events.

When the required event is selected administrator is redirected to the New Email page.

This is the page where store administrator creates: new event emails by specifying all necessary email attributes, email body and the conditions on what the email will be sent.

The settings available are as follows:

  • Event – allows selecting a trigger Event;
  • Email Name – allows specifying the name of the email for internal identification (not visible to customer);
  • Email Subject – allows defining an email subject (visible to customers);
  • Email Content – in this field store administrator is suggested to compose an email body, specify any necessary information and give the email a required look.

Email Content field is encrowned with the following buttons:

  • Show / Hide Editor – allows enabling/disabling WYSIWYG (What You See Is What You Get) editor;
  • Insert Frontend App... – allows inserting any native Magento frontend app to the Email body (CMS blocks, Catalog Product List etc.);
  • Insert Image... – allows attaching images to the Email body either from the store's media storage or uploading an image required;
  • Insert Variable... – allows inserting native Magento and Follow Up Email specific variables to the Email body (once an Email is sent the variable is converted into a corresponding value).

Email variables

In addition to a list of variables available by clicking Insert Variable... button, the emails can use native Magento 2.0 email variables and referrences.

To learn more about accessing objects in the emails follow the Magento documentation on how to customize email templates.

In addition to the standard "fixed" links, Follow Up Email extension allows inserting dynamic links into the emails (e.g., a link to the product a customer has purchased).

Using standard Magento methods, you can include dynamic links to virtually any Magento frontend area. The approach is based on using the store directive (which returns www.your_domain.com/ if used), supplied with URL postfix and optional parameters.

For example, you can insert a direct link to a product page (the store directive gives the base part, and the var gives the product ID we'd like to treat):

Code Block
languagehtml/xml
<a href="{{store url="catalog/product/view" id="$row_item.product.id"}}">{{var row_item.name}}</a>

Do not modify the line of the code above and DO NOT INSERT YOUR STORE URL

In a similar manner, your can insert the link to the product reviews page:

Code Block
languagehtml/xml
<a href="{{store url="review/product/list" id="$row_item.product.id"}}">Product reviews</a>

You can also create a link to re-order page for your registered customers:

Code Block
languagexml
<p> Please follow the link to reorder <a href="{{store url="sales/order/reorder" order_id="$order.id"}}">link</a></p>

This link will work for any order-related rule, and can be used e.g. for order failure notifications ("Order Obtained 'Cancelled' Status"), etc.

Using such an approach you can reproduce almost all the links used by Magento in its front-end part.

NOTE: the availability of a given URL parameter depends on the type of the rule your are using the template for. For instance, item.product_id can only be used for product-related events.

'for' directive

Order, Cart or Wishlist item displaying

The 'for' directive lets you 'walk' through any object collection that can be iterated (typically it's intended to walk through the items collection of an Order, a Cart, or a Wishlist objects, depending on the current rule and event context).

The directive syntax is as follows:

Code Block
languagexml
{{for item in object_name}}
 // iterated content
{{/for}}

The object_name is an items collection object that will be iterated (typically an Items collection of an Order, a Cart, or a Wishlist, depending on the rule context). Item parameter is the name of the object presenting the item inside the iteration.

For example, if you want to list an Order items, then your code can look like this:

Code Block
languagexml
{{for item in order.getAllVisibleItems()}}
{{var item.qty_ordered|formatDecimal}} x {{var item.name}}
{{/for}}


Formatting values

The extension allows changing the representation of certain variables' values. See below for details on available formatting options.

Price values

The new formatPrice variable modifier formats the value given with current store Currency setting according to its locale. The usage of the formatPrice is quite simple:

Code Block
languagexml
{{var price|formatPrice}}


Decimal values

The new formatDecimal variable modifier formats the value given. The usage of the formatDecimal is as follows:

Code Block
languagexml
{{var number|formatDecimal}}
or {{var number|formatDecimal:decimals}}
or {{var number|formatDecimal:decimals:dec_point:thousands_sep}}

The modifier accepts either zero, one, or three parameters (not two):

If no parameters are given, number will be formatted without decimals, but with a comma (",") between every group of thousands.

If one parameter is given, number will be formatted with decimals with a dot (".") in front, and a comma (",") between every group of thousands.

If three parameters are given, number will be formatted with decimals, dec_point instead of a dot (".") before the decimals and thousands_sep instead of a comma (",") between every group of thousands. Note that only the first character of thousands_sep is used.

Email Scheduling

Once done with the email attributes store administrator is suggested to schedule the email:

Schedule defines in what time after customer triggered an event the follow up should be sent.

After done with the schedule store administrator is suggested to specify the conditions on what the follow up is sent.

Conditions include:

            • Product attributes;
            • Store views;
            • Product types;
            • Customer groups.

 

 

Info

How do conditions work?

For example store administrator has set up the following conditions for Abandoned Checkout event:

  • Store view = Store #1;
  • Customer groups = General;
  • Subtotal equals or greater than $100;
  • Color of the item in the cart = red.

On such conditions Abandoned Checkout follow up will only be sent to the customer from General group, who placed a red item with price of at least $100 in the cart at the Store #1.

These are all the settings and options store administrator has to specify before saving a new email event.

Available Event Emails

The last item of the Events section is the list of available event emails. The list includes pre-defined emails that come with the extension installation package and all the emails store administrator has created.

The event emails are nested under the corresponding events making it navigation friendly.

Each event email comes with a short description including:

  • Name;
  • Subject;
  • Schedule.

The name of the event email is clickable for quick editing. In addition all the event emails come with Disable/Enable buttons and Delete button, allowing store administrator to enable required emails or delete the obsolete ones in few clicks.

 


Mail Log

 

Section

Mail Log is where all the scheduled and sent follow ups are stored.

From the Mail Log page store administrator can:

  • Preview follow ups;
  • Cancel scheduled follow ups;
  • Delete follow ups;
  • Send now.

Basically, this page allows manually managing all the follow ups.

UI Button
titleProduct Page
colororange
urlhttps://ecommerce.aheadworks.com/magento-2-extensions/follow-up-email/


You can always find the latest version of the software, full documentation, demos, screenshots, and reviews on http://ecommerce.aheadworks.com
License agreement: http://ecommerce.aheadworks.com/LICENSE-M1.txt
Contact Us: http://ecommerce.aheadworks.com/contacts/
Copyright © 2018 Aheadworks Co. http://www.aheadworks.com