PrestaShop Emails SDK
JavaScript CSS Smarty
Latest commit 110e37c Jan 9, 2017 @Scritik Scritik Update api url
Permalink
Failed to load latest commit information.
src Added author to settings Dec 14, 2016
.gitignore First version Oct 10, 2016
LICENSE.md Update LICENSE.md Oct 10, 2016
README.md First version Oct 10, 2016
gulpfile.js Update api url Jan 9, 2017
package.json Upgrade version of mjml (#2) Oct 24, 2016

README.md

What is this?

The PrestaShop Emails SDK is a toolkit to create custom emails for PrestaShop 1.5, 1.6 and 1.7.

Installation

You first need to install Node.js.

Install Gulp:

npm install -g gulp

Download or clone the repository

Install all the dependencies:

cd email-templates-sdk
npm install

Before anything, you need to download required languages:

gulp langs:dl

Usage

During development, you just need to watch files:

gulp watch

This will detect changes on your files and output a compiled version in ./dist/en/.
3 languages are available during development but more languages are available when the emails are installed on PrestaShop. More information below.

Build

To install the emails on PrestaShop, you need to build a package:

gulp build

This will create a zip file in ./dist/ with the name you set in the ./src/config/settings.json.

To install the zip file that contains the emails, you need to use the Emails Manager available in the PrestaShop back office (soon). This is also this file you will need to submit on PrestaShop Addons if you want to sell it. The emails are translated by the module during the installation and the dynamic variables & conditions are processed (see "Dynamic variables" and "Conditions" for more information).

MJML: Emails made easy

Building emails is not easy. We know that and Mailjet too. This is why they created a framework to develop emails and make sure they will work fine for all email clients.

We chose to use this framework to help you develop your emails for PrestaShop. The better part is that Mailjet improves MJML everyday and you can enjoy it directly.

All the PrestaShop's emails have been converted in a MJML format so you can create your own emails based on it.

You can find a complete documentation on the official website.

Translations

Emails are automatically translated when they are installed. This is why you can find variables like this in your templates:

${{ lang.my_variable }}$

Make sure to use these variables and not hard coded text.

Dynamic variables

In order to allow the merchants to customize they emails, you can create dynamic variables. In your email, you just need to include a variable where you want:

{{$my_var}}

For every variable, you need to declare it in ./src/config/settings.json

{
  "product_key": "",
  "name": "preston",
  "version": "1.0",
  "inputs": [
    {
      "type": "text", // Two types are supported: text or color
      "name": "my_var",
      "default": "",
      "required": false,
      "label": {
        "en": "English label",
        "fr": "French label",
        ...
      },
      "desc": {
        "en": "English description",
        "fr": "French description",
        ...
      }
    }
  ]
}

To help you during your development, you can use the ./src/config/fake.json to declare fake data. This will replace the variables in the compiled versions.

You can replace :

  • Your dynamic variables.
  • Default variables like {shop_name}. The default fake.json already comes with almost all the default variables.
  • Whatever you want!

Note: A few variables for PrestaShop 1.5 are also available in the fake.json. When you want to test for this version, just temporarly replace the variables in your templates.

Conditions

You will sometimes need to add some conditions. Social links are a good example as the merchants are not using all of them.

Your conditions must be really simple and only check if a variable is here.

<mj-raw>{{if $my_var}}</mj-raw>
    // Your code
<mj-raw>{/if}</mj-raw>

You can find real examples in the default template's footer.

Partials

If you want to include the same code in multiple files, you can use partials. Create a new file in the ./src/partials/ folder and then, include it where you want:

<mj-include path="./src/partials/your_file.mjml" />

Global CSS

MJML lets you custom every components with attributes and we really recommend you to do it like this but sometimes, you will need to add some global CSS. Media queries are a good example.

Another good example is the order_conf.html email. On PrestaShop 1.5, the products list is hard coded and you can't change the HTML so you will need to custom the style. You will have to do it in the global CSS. Take a look at the default template for an example.

Starting 1.6, tpl files are used in the order_conf.html and we provide a better version in this SDK. You can edit the files as much as you want, they will replace the default files.

Tests & Compatibility

We recommend you to test your emails with Litmus. On PrestaShop Addons, we will use it to make sure that your emails are valid on the most common email clients, both desktop and mobile. You can also create a few accounts (GMail, Yahoo...) to test it yourself.