How to Set up Template Error Management and Why We Need It

Testing your email templates is tough. Who wants to be checking thousands of code lines for 50 different templates?

That’s why choosing a bug reporting process is necessary. At Mailjet, we are trying to make it as easy as possible for you to do this with our Template Error Management options. Read on and we’ll tell you what Error Reporting is and why you’ll love it. 😉

What is Error Reporting

Good error reporting is essential when building and debugging email templates. No one wants to look at a template for hours, just to see that one small comma is missing…😒 You know the feeling when you want to break your screen with your keyboard? We do and we know how unpleasant it is.

Collaboration Toolkit

As you can imagine, filling out manually a big bug report can take a while. If you need to report dozens of bugs during a testing session, it could take you several hours for one template… This would be painful.

There are many different elements you can include in your bug report. However, using a bug tracker is probably the best way for your organization to move bugs from reported to fixed and help you stay focused. As powerful as bug tracking tools are, the big problem is that you need every person working on the templates to use them and to know how to manage them. But how do you explain to a marketer what “node” means? 🤷

Mailjet’s error reporting is super easy to use for developers, because it gives you a headstart and shows you what to fix and where. For non-developers, it helps to provide more details to you instead of having to rely on insufficient information like say “I got blank / white page”. We all know how no one touched anything, but still something is not working…

template-error-management-fun

Template Error Management at Mailjet

Our goal at Mailjet is to make our products as easy to use as possible. You already know that using our template language is a piece of cake, but it is possible that you missed one curly bracket or a variable was not written correctly and this is breaking everything.

Or you sent the template to the design team to put all the appropriate colors for your brand and someone removed something that seemed strange to them. In fact, it was the most important part of the amazing loop you created.

We don’t want you to waste your time digging into what went wrong, and so we built a solution for you – Template Error Management! We are offering two options:

  • Template Error Reporting
  • Template Error Deliver

Template Error Reporting

Have you ever sent an email but it was not delivered? This could be because our system detected an error with your template and aborted the sending. The main purpose of our template error reporting option is to send you an email to let you know that there is something wrong and provide a detailed explanation of the issue. Here is how it works:

  1. You create a beautiful email template
  2. You compose your API call and declare all of your variables in it
  3. The email is sent by you to our system
  4. Our system checks the template and replaces all the variables with their corresponding values
  5. Our system finds an error
  6. The sending is stopped unless you chose otherwise
  7. Mailjet sends you an email with the error details

So, the first two steps are something that you usually do just perfectly, but this time there was one small mistake in your template. If you have one big template full with loops and conditions, checking everything manually could take forever. This is why we are offering our template error reporting.

To activate it you only need to add this piece of code in your API call:

"TemplateErrorReporting": {
"Email": "youremail@youtdomain@com",
"Name": "Your name"
}

It is important to write the correct email address, because our system will send the report to this address.

These reports should not be an issue for you because the errors are pretty self-explanatory, but we’ve provided some examples of the most common errors below:

unexpected end of template:unfinished end of node ## near ## {{var:url – One of the variables are not closed correctly. In our example above, the variable is missing two closed brackets (i.e. }}) at the end and because of this our template language engine is not recognizing it and cannot compile the template correctly.

not valid template – the template you chose is not the correct one. Most likely the ID does not correspond to the right one. Our system is not detecting the variables you declared in our API call in the template, so you should first check if the template’s ID is correct.

unknown node ## near ## – There is a syntax error in the template. You should check if you have declared all the loops in template language sections.

“var:firstname” is not an array value – This error is generally returned when you try to loop on a non-array value. If you set up a loop as this {% for fn in var:firstname %}, you should declare something like this in your API call: {“firstname”:[“Jane”,”Joe”]}. If this is not declared, our system cannot compile the variables.

No value for “var:items” – you haven’t set up the variable in your API call. If a variable is not declared, our system is not able to replace it in the template with the corresponding value. We don’t want to send a template with {{var:items}} in it, because the recipient wouldn’t know what this should be.

expression parsing error ## Unknown identifier: var:day ## near ## {{var:day ## – This error indicates that the “day” variable is not defined in your Vars. It can be fixed by adding the default value for the variable or making sure that you pass all the variables required by the template.

expression parsing error ## Unknown identifier: day ## near ## {{day ## – This error is similar to the previous one, except for the absence of namespace (var or data). It can indicate that you forgot to specify whether you want to use a Send API variable var:day or a contact property data:day. It can also indicate that you are trying to use a template variable that is not defined in a set function nor a loop statement.

not valid template ## near ## y}} ## – This error occurs when the statement is not finished – missing {% endif %}

What should you do when you receive ## Unknown identifier: var:day ## near ## {{var:day ##, but you don’t see such variable in your template?Well… did you update the plain text version of the template? If the plain text version of the template is not updated, it still contains all the old variables and our system is still trying to compile them. This is why it is better to use our template error reporting. It is much easier for you to manage your templates and to fix some small errors that happened for any given reason.

Template Error Deliver

This second option determines if the message should – or should not – be delivered to the recipient in case of an error while processing the message’s template language. If the below line is not added in your API call, our system will assume this option is not enabled by default:

"TemplateErrorDeliver": true

What does it mean? If you don’t have this small code in your API call, in case there is any error in your template, the email won’t send. Our system will detect the error, it will send you an email with the error report (if you have switched on the Template Error Reporting option of course), and it will not proceed with the sending of the template to your recipients.

However, if you are still in the testing phase, it might be helpful to have this activated. If there is an error in your template, you will receive the error reporting, but you will also receive the uncompiled template itself. Our system will detect the error and will send you the error report email. However, our system will also see that the Template Error Deliver is active and it will send the emails anyways, just as they are.

So the recipient will see all the loops and variables without them being replaced with the data you set up in your API call. Yes, the template won’t look as pretty as it should (and as you and your great design team created it), but it will give you some general idea on how the template will look.

If you want to avoid any errors once your templates are in production, it would be better to remove “TemplateErrorDeliver”: true from your API call. You won’t risk having your template delivered, which will avoid any confusion from your contacts.

template-error-deliver

It is still helpful, though, to keep the Template Error Reporting element active so you can receive an email if there is something wrong with your template.

Template Error Management helps you resolve all issues with the template language in your email templates without losing a lot of time and nerves. Our dedicated API support is always here to help you resolve your issues, if you need any additional help identifying the problem or understanding the error you received via email.

If you want to be the first to get the next useful tips we are going to publish, follow us on Twitter and Facebook. Make sure not to miss a thing!

How To Code An Abandoned Cart Email With MJML

You know how many customers are leaving some items in their carts without processing to the actual purchase? We’re here to make sure you’re ready to give your customers that extra nudge and remind them about those items they once left behind in their carts. Even better you are going to make them even happier, by telling them that those items are on sale. 😏

If you’re a thorough follower of our tutorials, you may already know that, we’re showing you how to create and send awesome transactional emails step by step. We’ve already showed you how to create welcome email and email receipt using template language and MJML. Now, you’ll learn how to create abandoned cart emails.

A templating language for your transactional emails

Are you tired of creating a separate template for all your needs? Template language is here to offer you the best solution! You’ll be able to create one template for all your purposes using our template language.

Template language is available in different languages and using multiple libraries, so you are probably familiar with at least one of them. It’ll be a piece of cake! 😉

Mailjet’s Templating Language

At Mailjet, we know the value of a fully integrated templating language, which is why we created our own templating language with our Transactional Send API in mind. We’re here to help you manage everything in one template, to save you time and effort.

So, let’s recap: MJML for producing responsive HTML emails without effort, plus a templating language to bring them to life with conditional blocks and variables.
This combo can change your life as a developer. But, enough words, you’ll definitely want some action. That’s why we’ve decided to show you how to create and send awesome transactional emails, step by step.

The “How to code” tutorial: what you need to know

We’re rolling out a series of tutorials, all of which will explore a very common use-case, providing numerous examples, code snippets and nice visuals. We’ve even created an easy-to-execute tool, written with NodeJS, to test emails under actual conditions. To use it, you’ll just need valid credentials for both MJML API and Mailjet Transactional Send API, but don’t worry if you’re a newcomer: applying for the MJML API beta and creating a Mailjet account are totally free.

Our “How To Code” series has four parts. Check them out now:

How to code an abandoned cart: Quick Introduction

Today, we’re going to see how to implement an efficient abandoned cart email using MJML, the open-source email framework with 7600+ stars on Github open-source email framework, and our templatе language. Here’s a quick preview:

abandoned-cart-preview

When a customer adds products to their cart but doesn’t check out, it doesn’t mean the sale is definitively over. Here are some numbers for you: 50% of abandoned cart emails are opened, and more than a third of them trigger clicks to redirect customers to the website. And these figures could be even higher during a sale, when you’ll have the chance to offer your customers that additional tempting discount.

This high rate can be easily explained: customers often abandon their carts without meaning to do so, be it because of website crashes or times out (sure, that never happens to yours), or simply because they needed some time to think. This is why an abandoned cart email can be a successful way to re-engage customers, guide them through to the last step in your buying process or allow them to recover lost purchases.

A proper abandoned cart email should include the following:

  1. The items left in the cart.
  2. An incentive, such as a discount or a special deal, personalized for your user.
  3. Some new articles your user may prefer.

Let’s focus on these points.

How to create an abandoned cart email

You should encourage your clients to resume their shopping experience, just where they left it. This implies that your email template should display the abandoned cart, just as it looks on your website, both in terms of design and in terms of the items left behind. Easy to say when you’re using the [name here any trendy JS framework], but how do you do this in an email? The solution: use our templating language loops and variables directly into your email to display a cart based on raw JSON data.

Coding the abandoned cart section

Let’s start from the top of the template. We are going to use mj-navbar as container. We’ll choose this container as it is better suited for our needs and it’s already formed by two mj-column. The first one will contain mj-image and the other one the mj-inline-links component, which will create your links based on a list of mj-link children.

Of course we are going to add some CSS code to make our template prettier and here’s what we have:

Coding the body of the template

Now, let’s see how to code the main body of the template. As a general rule, it is recommended to keep it as close as possible to your cart’s main design on the website. Here’s our code:

As you can see, we’re using two nested mj-section. We’ll do this because the MJML API we’re using for this tutorial does not support the component yet.

Defining the items in the cart

Next, we’re going to configure everything related to the items in the cart. To do so, we are going to set up this loop {% for single_element in array_variable %}, using the following pattern: {{ var:property_key:default_value }}. Within the loop, a new variable single_element is created and updated for each iteration, ready to be used.
Here’s the MJML code for the display:

If you want to know how to set up your API call, visit our documentation here.

Coding the section with the additional discount

We are almost done! Now we need to let our customers know the good news! There are sales, oh surprise, the items that they left behind are now with discount! Who doesn’t love discounts? Probably some customers abandon their carts because they initially thought your products were cheaper. Hold on… Where did all these taxes and shipping fees come from? Well now, with the discount on the items, the customers won’t even notice those additional costs.
Here again, we’ll use a mj-table to display two sub-columns:

To win these customers back, the best way is to issue a discount or offer them free shipping, in the form of a deal that looks as if it was directly branded for them. To do this, add blocks to your template that only show up under specific conditions. In this tutorial, conditional blocks come to the rescue.

How to code section with other suggestion

Abandoned cart emails can provide a nice opportunity to present other products. You surely have a nice algorithm for recommendations – use it to generate some JSON data and, with our templating language, display nice personalized blocks directly in your email.

How to code CTA button

This is the easiest part. 😉 To add the CTA button, just use the code below for the mj-button:

Time to jump on Github

OK, we’ve given you an overview and some code examples to create an amazing abandoned cart email. Now it’s time to create your own with your own design.
You’ll find everything you need on our detailed tutorial on Github, complete with examples and code samples.

Github-tutorial-blogpost-banner 4

Have you missed the previous tutorials? Check them out here:

How to create an e-commerce receipt email

How to send a welcome series email

We’ve also created an easy-to-execute tool, written with NodeJS, to test emails under actual conditions. To use it, you’ll just need valid credentials for both the MJML API and Mailjet’s Transactional Send API. Don’t worry if you’re a newcomer: applying to the MJML API beta and creating a Mailjet account are totally free.

Do you want to be informed about the next tutorials? Come and say “hi” on Twitter or join us for a chat on Facebook

How to Use Templating Language to Send Truly Personalized Emails

Dear {{var:name}},

Wouldn’t it be cool to read an article that actually starts with your name? It would certainly grab your attention.

Well, what still sounds like a distant fantasy for the Mailjet blog is definitely a possibility for your emails using a template language.

If you’re not familiar with it yet, this post will tell you all you need to know to turn the template language function into your new email best friend.

What is template language?

A template language is a language that allows you to define placeholders within your templates that will be personalized depending on a set of variables or property details. Modern template languages don’t only support placeholders, but also loops and conditions that are often necessary to design a web page or an email.

Everyone likes to feel a personal touch in the emails they receive. It’s like if someone had thought about what you’d like to see, and had handpicked the perfect items or information just for you. We are not only talking about including a client’s first name, but using all kind of conditions, loops and functions to display content based on the recipient’s interests.

You’re probably already receiving these personalized emails while playing World of Warcraft, probably from Blizzard alerting you about the new great promotion on ingame items. So why not doing for your business too? It’s actually pretty easy to do, and email personalization usually increases the open rate by over 30%.

For example, say you have a sport e-store. You could send golfer Frank an email with all your new golf sticks, while tennis-player Diane would receive a message featuring the best tennis rackets.

If you are wondering how much is too much personalization, worry not – there is no such thing! Anything that’s personalized in the email will draw the recipient’s attention. And if you are showing them the perfect items, this will for sure generate more visits and purchases on your site. Think about your email as an invitation to check out what you found for them.

Why should you use Template language?

By using a template language for your transactional emails, you’ll be able to work with fewer templates, which will include different sections that will be displayed depending on the situation. Yes, you’ll still need a different template for account creation and for password reset, but there is no need to have five separate ones for each language you work with, for example.

Using Template language, you can add different sections for each language you need in one same template or propose a range of products for men and women in your order confirmation emails, using sections that display based on the client’s language or gender. Our system will collaborate with yours and show the appropriate option, depending on the customer’s properties defined as a variables in the API call.

Give it a try and see the magic behind the template language – you’ll never want to go back to working on 100 different emails for hours (or days…)!

How to use Mailjet’s template language?

Template languages and libraries are available for many programming languages, and choosing a language for your current needs is not difficult.

Mailjet’s Template Language follows a syntax close to the one used by the most popular template languages, such as Jinja2 or Twig, which means you’ll already be familiar with it. We made is easy and logical so even non-programmers can use it. 😉

Mailjet’s Template Language offers the perfect balance between power and ease.

You can apply it to your transactional emails using our awesome API, our collaborative editor Passport, MJML or HTML.

Mailjet’s template language can be used with IF conditions and FOR loops (wrapped between {% … %} delimitators) and supports the following operators:

  • Arithmetic operators,
  • Comparison operators,
  • Logical operators.

To learn more about which ones you can use and how to add them, check out our documentation here.

Let’s get practical: Applying high personalization with templating language in Mailjet’s builder

We know you’re probably keen to learn how it works, so let’s see how you could use some basic template language functions in Passport, Mailjet’s intuitive email builder, and then declare the variables in your API call.

Step 1: Creating the template

To get started, first create the template you need. In our example, we’ll work with an order confirmation.

Let’s say that Diane bought one of the tennis rackets you sent her (hooray!) and now you want to:

  1. Confirm her order.
  2. Show her items that she could also like.
  3. Give her an additional discount for her next purchase, which you normally do after a client’s third purchase.

This is the information we already have about Diane in our database:

First Name: Diane
Age: 28
Sports: Tennis
Number of purchases: 3

So, to get started, we’ll choose a template from Mailjet’s template gallery, add our logo and create our copy, with variables that we can set up, even without the template language.

This is what the template would look like:

order confirmation - first part

As you can see above, we’ve used these variables: {{var:ordernumber}}, {{var:firstname}}, {{var:product}} and {{var:companyname}}.

Step 2: Adding order details with Mailjet’s Template Language

So now for the fun part – using Mailjet’s Template Language. Just drag and drop the template language section wherever you want within the template, like this:

how-to-use-template-language-section

It might look like a boring section now, but not for long.

To display all the details of the purchased item and add new product proposals for Diane, you just need to click on the < > brackets that will show up when you select the section. A new window will open so you can add the code.

In the first section we are going to add {% for %} statement that will include an array of variables with all the details about the purchase. In our case it will look like this:

{% for article in var:products %}
{{ article.name }}
{{article.number}}
{{article.price}}
{{article.totalprice}}
{% endfor%}

You can choose the style and declare it as you wish in the same window in which you set up the loop.

Step 3: Displaying product recommendations

We are going to add a second template language section now. Let’s use one of our editor’s cool features and choose a section that should only be displayed to customers with that have added tennis as their favorite sport.

It’s actually pretty easy to do this. You just need to click on the section you want to apply the personalization to, and the option will appear in the upper left corner. This is an easy way to use an IF conditions for whole section.

template-language-section-condition

Now, click on “Add condition” and configure the right option for your specific use case. Here’s ours:

condition-section-template-language

Here, we’ll add the array of variables to be shown to customers that have marked tennis as their favorite sport:

{% for line in var:suggestions %}
{% for product in line %}
{{product.name}}
{{product.price}}
{% endfor %}
{% endfor %}

You can add as many of these sections as you want, based on everyone’s favorite sport, but you should also set a section without any conditions in which you include some basic suggestions for those that haven’t specified a favorite sport.

Step 4 – Adding shipping and billing information

Next, you want to add a new section with the billing information and shipping details, in two columns. This is what the section will look like:

template-language-billing-section

Step 5 – Including a discount

Finally, we’ll add a section offering Diane her and we are going to thank her:

template-language-thank-you-section

And here is the whole template we created together:

template-languae-order-confirmation-code

Step 6 – Syncing Mailjet’s Template Language with your system

We’re nearly there.
Below you can see the API call we’ll use to turn this rather plain template into a really cool confirmation email.
Here’s where we need your system to be involved. You’ll have to create a script on your end that will fill out all the variables with the all information you have about Diane and about your products.

curl -s \
    -X POST \
    --user "$MJ_APIKEY_PUBLIC:$MJ_APIKEY_PRIVATE" \
    https://api.mailjet.com/v3.1/send \
    -H 'Content-Type: application/json' \
    -d {
        "Messages":[
                {
                        "From": {
                                "Email": "youremail@yourdmaint.com",
                                "Name": "Your Name"
                        },
                        "To": [
                                {
                                        "Email": "recipeintemail@domain.com",
                                        "Name": "Recipient Name"
                                }
                        ],
                        "Variables": {
                        "ordernumber": "#12345",
                        "firstname": "Diane",
                        "product": "Tennis Racket",
                        "companyname": "Sport",
                        "products":[
			{
			"name": "Product: Tennis Racket",
			"number":  "Quantity: 1",
			"price": "Price : $30.00",
			"totalprice":"Total Price: $30.00"
			}
			],
	"suggestions": [
		[
			{
			"img": "",
			"name":  "Product: Tennis skirt",
			"price": "Price: 23€"		
			},
			{
			"img": "",
			"name": "Product:  Tennis bag",
			"price":  "Price: 45€"
			},
			{
			"img": "",
			"name": "Product: Tennis balls",
			"price": "Price: 8€"
			}
		]
		],
		"billingfull_name": "Adress: Your address",
		"billing_city": "City: Paris",
		"billing_addresspostal_code": "Postal code: 75008",
		"shippingfull_name": "Adress: Your address",
		"shipping_city": "City: Paris",
		"shipping_addresspostal_code": "Postal code: 75008",
		"discount": "10%",
		"Sport": "tennis"
                        },
                        "TemplateID": 123,
                        "TemplateLanguage": true,
                        "TemplateErrorReporting": {
					"Email": "youremail@yourdmaint.com",
                              			 "Name": "Your Name"
				},
                        "Subject": "Order confirmation"
                }
        ]
    }

Once that’s done, you can add some finishing touches to the template and voilà, all is done and the email is ready to be sent. Here’s what Diane will receive:

template-language-final-email

Looks great right? Now you know how to create amazing templates like this one with Mailjet. 😏 And soon, we’ll show you how to do this with HTML and more advanced functionalities of our template language, so you can take this to the next level.

Wrapping up:

We’ve explained the wonders of using a template language and shown you how to create an order confirmation email with Mailjet’s Template Language and our email editor, Passport.

But there’s so much more you can do! This dynamic duo will help you create amazing account confirmation emails, password reset emails, abandoned cart notifications, etc. Keep an eye out for our next posts, in which we’ll show you how to do just that, using the template language in Passport, or applying it on MJML or HTML.

And… don’t forget to follow us on Twitter and join us on Facebook as well! We are always happy to hear your ideas and comments. :)

How to Set Up a Double Opt-In Subscription Form via Mailjet’s API

Deliverability is a pain. We know it.

That’s why, here at Mailjet, we are doing our best to get your emails straight into the inbox, but we need your help as well. We know that you want this too, in order to consistently generate more visits to your site.

While Mailjet can provide a solid infrastructure, industry leading deliverability tools, and a team devoted to you deliverability, your role in this partnership is to ensure 100% of your list has opted-in to receive communications. Because they have, haven’t they? 😉

Opt in for best deliverability

Opt-in subscription forms can be used to capture contact information from customers and visitors in a variety of ways: pop-up forms on the homepage or product pages, dedicated landing pages, and embedded widgets across your website.

A customer subscribing on your platform is like a verbal confirmation of interest in receiving your communications, however a double opt-in subscriber is like getting their signature. Not only does it really prove their consent, but it also is indicative that they really want to engage with your content, products, or services. These are the most valuable contacts.

single opt-in vs double opt-in

Single opt-in vs Double opt-in

There are two types of opt-ins – single and double. While the single opt-in only requires users to provide their email address in one step, the double opt-in widget includes two steps to confirm the subscription. Single opt-in subscriptions skips a crucial second step – confirmation. Side note: Stay tuned for our next article where will explain more about the differences between single and double opt-in.

Why is double opt-in better?

This validation process consists of receiving an email with a custom confirmation link.This will guarantee that the address is in fact valid and it’s owner agrees to receive your marketing campaigns. It eliminates the chance of abuse where somebody submits somebody else’s email address without their knowledge and against their will. At the same time, typos in email addresses are also caught, as are the risk of bots mass subscribing to your content.

By using double opt-in you can reduce spam complaints down to well within acceptable levels (e.g. at Mailjet we make sure our users do not get more thank 0.08% spam complaints).. While double opt-in is not obligatory by law yet, the GDPR is still requesting valid and unambiguous consent for subscription.

GDPR double opt-in

Often quality is better than quantity, and this is certainly the case in emailing. You will have very strong deliverability rates and you will know your audience will be anticipating and willing to read your newsletters. This sure beats sending emails to addresses with typos, bots, or fake accounts.

How to set up a double opt-in through Mailjet’s API

By now hopefully we have convinced you that it is far better for you to use a double opt-in subscription widget, so now we are going to explain how to create one through our API. This is a good solution if you already have an existing opt-in and you just want to connect it to Mailjet, or if you think using our subscription widget is just… too easy for you. 😏

In the diagram below you can see a schema of the process and the steps to follow to make the connection between your system and ours through our API:

Now, let’s have a look at the different steps.

Blog-Double-Opt-In-Schema

Step 1 – Contact’s subscription

Lucky you! Your visitor has decided to subscribe to one or more newsletters via an opt-in on your site.

This form can also contain additional contact properties (like first name, last name, city, gender, etc.). Basically, anything you find useful later to segment your list or personalize your newsletter.

Step 2 – Creation of the customized confirmation link

When the user completes the subscription form, the email address and contact properties will be saved on your system. Then you will have to generate the custom confirmation link that should be send to the client by email. This custom URL should guarantee that the subscription cannot be faked and only the person you are addressing can click on it.

For example you can use MD5 hash algorithm to convert the name of the recipient to 128-bit hash value. Then you could insert it as a variable at the end of the confirmation link. Your system will perform a MD5​ of the email address concatenated to a specific SecretKey​ which will be corresponding to the custom URL.

 http://mysystem.com?{{var:Email​OfTheUser}}&{{var:MD5hash}}

 

Step 3 – Sending of the confirmation email

After your system creates the customized confirmation link, it is time to leverage our Send API through a POST request. You should create a template for the confirmation email that will contain the custom URL. You can design the template with our intuitive email builder, Passport, or via our API using Mailjet’s templating language. You can insert the confirmation link behind a button or just as it is. Below you can see an example of an API call that you can use:

# This call sends a message to one recipient.
curl -s \
-X POST \
--user "$MJ_APIKEY_PUBLIC:$MJ_APIKEY_PRIVATE" \
https://api.mailjet.com/v3.1/send \
-H 'Content-Type: application/json’ \
-d ‘{
    "Messages":[
            {
                        "From": {
                                 "Email": "sender@email.com",
                                 "Name": "Sender Name"
                        },
                        "To": [
                                {
                                     "Email": "recipient@email.com, 
                                     "Name": "Recipient Name"
                                }
                        ],
                        "Variables": {
                                "MD5hash": "MD5hash",
                                 "EmailOfTheUser": "EmailOfTheUser"
                        },
                        "TemplateLanguage": true,
                        "Subject": "The subject you want", 
                        "TextPart": "Welcome to our mailing list! Please activate your subscription by clicking in this link: 
http://mysystem.com?{{var:EmailOfTheUser}}&{{var:MD5hash}}", 
                        "HTMLPart": "Welcome to our mailing list! Please activate your subscription by clicking in this link: 
http://mysystem.com?{{var:EmailOfTheUser}}&{{var:MD5hash}}" 
                       } 
           ]
   }’

 

Step 4 – Creation of template

If you want to use an awesome template you created with our email editor, Passport, or with MJML / HTML code, you can send it easily with the API, by following the steps here or using the example below:

curl -s \
    -X POST \
    --user "$MJ_APIKEY_PUBLIC:$MJ_APIKEY_PRIVATE" \
    https://api.mailjet.com/v3.1/send \
    -H 'Content-Type: application/json' \
    -d '{
        "Messages":[
                {
                        "From": {
                                "Email": "sender@email.com",
                                "Name": "Sender Name"
                        },
                        "To": [
                                {
                                        "Email": "recipient@email.com",
                                        "Name": "Recipient Name"
                                }
                        ],
                                "Variables": {
                                "MD5hash":“MD5hash",
                                       "EmailOfTheUser": "EmailOfTheUser"
},
                         "TemplateLanguage": true,
                         "TemplateID": 123,
                         "Subject": "The subject you want to use"
                          }
                 ]         
             }'

 

Step 5 – Customer’s confirmation

At this step, the action should be completed by your customer. They are going to receive your email and they will have to click on the confirmation link in it.

Step 6 – Adding and sync of the contact

The user has done their part and that means that they are ready to be added to your contact list. Now a confirmation page should be displayed to them thanking them for their subscription.

The opening of this page should refer back to your system with the appropriate parameters (email and MD5 hash). They will give you the MD5 checksum (Secret Key) corresponding to the confirmation link associated with this user. If the parameters are correct, the contact will be added in your system.

MD5 checksum == EmailOfTheUser + MD5 hash value

Example:
Recipient Name: John Smith and recipient email johnsmith@email.com

Secret key in your system == johnsmith@email.com + 6117323d2cabbc17d44c2b44587f682c

Step 7 – Adding customer’s properties

Only one thing left to do – add the client to the list and attribute the properties they provided. This can be done by your system which should call Manage Contacts endpoint of our API.

Here’s an example of the request:

 # Add a contact to the list
curl -s \
    -X POST \
    --user "$MJ_APIKEY_PUBLIC:$MJ_APIKEY_PRIVATE" \
    https://api.mailjet.com/v3/REST/contactslist/$LIST_ID/managecontact \
    -H 'Content-Type: application/json' \
    -d '{
        "Email":"recipeint@email.com",
        "Name":"Recipient Name",
        "Action":"addnoforce",
        "Properties":{
                "property1": "value",
                "propertyN": "valueN"
        }
    }'

 

Important: If your contact specified some properties, you should make sure you have defined those properties in advance in the Mailjet system with the user interface or with the API.

# Create : Definition of available extra data items for contacts.
curl -s \
    -X POST \
    --user "$MJ_APIKEY_PUBLIC:$MJ_APIKEY_PRIVATE" \
    https://api.mailjet.com/v3/REST/contactmetadata \
    -H 'Content-Type: application/json' \
    -d '{
        "Datatype":"str",
        "Name":"Age",
        "NameSpace":"static"
    }'

 

And with that, it is all done!

Collaboration Toolkit

Summing up

We’re sure by now, you’re convinced double opt-in is the way to go to ensure you’re only sending emails to contacts that really want to receive them, and to ensure optimal deliverability.

Once you have created your widget and configured the scripts to sync your contacts with with Mailjet, you’re ready to start sending. From now on, any contact that enters your database and confirms their subscription will become part of your list at Mailjet, with all of the properties they declared.

Now you can continue with the creation of your awesome campaigns to send to all those new subscribers. You can see how to do so here.

Share your thoughts and ideas with us on Twitter and Facebook, and follow us to be the first to get the news!

How To Code A Welcome Email With MJML

You already know we’re working on a series of tutorials to show you how to create and send awesome transactional emails step by step, using MJML, our open-source email framework, and Mailjet’s templating language. Each tutorial covers a very common use-case, providing a large set of examples, code snippets, and nice visuals.

Today, we’re going to see how to implement an efficient welcome email. Here’s what you’ll find in this post.

 

A templating language for your transactional emails

You already know that flexibility and personalization are a must-have in the email industry. Transactional emails imply more and more complex business logic, and one can often struggle to try to juggle a lot of different templates, when they could just have one personalized email that adapts to several use cases.

Having a separate template for men and another one for women, or creating specific campaigns to recommend different things based on your customer’s previous purchases is not viable. It is in this kind of situations that a templating language comes in handy.

Even if you could potentially write your own, to be able to implement a tokenizer and a grammar, you’d need to have a good knowledge in the field and might end up reinventing the wheel when you could have been focusing on your core business instead…

You could instead use nice libraries such as Handlebars, Jinja or Twig, but then you’ll still need to write or host a dedicated service to handle the templating processing.

Mailjet’s Templating Language

At Mailjet, we know the value of a fully integrated templating language, which is why we created our own templating language with our Transactional Send API in mind. Our idea: one template to rule them all, just with a single API call.

So, let’s recap: MJML for producing responsive HTML emails without effort, plus a templating language to bring them to life with conditional blocks and variables.

This combo can change your life as a developer. But, enough words, you’ll definitely want some action. That’s why we’ve decided to show you how to create and send awesome transactional emails, step by step.

 

The “How to code” tutorial: what you need to know

We’re rolling out a series of tutorials, all of which will explore a very common use-case, providing numerous examples, code snippets and nice visuals. We’ve even created an easy-to-execute tool, written with NodeJS, to test emails under actual conditions. To use it, you’ll just need valid credentials for both MJML API and Mailjet Transactional Send API, but don’t worry if you’re a newcomer: applying for the MJML API beta and creating a Mailjet account are totally free.

Our “How To Code” series has four parts. Check them out now:

 

How to code a welcome email: Quick Introduction

We know you are an email veteran, and the double opt-in has no more secrets for you. So, during the signup process, you asked your user to confirm their email address. This verification step is now over. You can open yet another bottle of champagne, you have one true new user interested in your product. Congratulations.

But then you start to wonder. It could be that users browse your website right now, or come back later. And you know people. Chances are, they’ll have other things to do, they’ll forget and never come back. So you need to grab their attention again. Why not use the valid email address they offered you willingly?

Welcome emails are indeed a powerful way to communicate because users are expecting them. When you enter a store as a consumer, you expect friendly greetings, useful information or good advice. While this behavior is common for most customers, that doesn’t imply they’re all the same. It is important to take your user’s tastes or habits into account, in order to create relevant messages. We can see you starting to panic: how many templates would you have to write?

Don’t freak out! Leveraging the power of our templating language, we will show you how to create a customized welcome series, using only a single template. In this tutorial, we will show you how to:

  1. Create blocks that display different elements according to your user data (location, gender… think segmentation!).
  2. Set a templating language variable and leverage it to display personalized data.
  3. Use templating language functions to transform text.

Example: welcome email

 

How to code a welcome email template: Over to Github!

Looking for some extra help in coding your welcome emails? You’re in the right place. We’ll tackle all the points above, and more, in our dedicated Github tutorial for coding welcome email templates with MJML.

Our Github tutorial includes:

  • Clear explanations.
  • Code samples you can use while working on your welcome emails.
  • Examples of a welcome emails and its different parts.

Ready to start writing an awesome welcome email template?

Time to jump over to Github.

Jump over to our Github tutorial for welcome emails!


We’ve also created an easy-to-execute tool written with NodeJS to test emails under real conditions. To use it, you’ll just need valid credentials for both MJML API and Mailjet Transactional Send API, but don’t worry if you’re a newcomer – applying to join the MJML API beta and creating a Mailjet account are totally free.

Want to say “hi” to the team? Come and chat with us on Twitter.

How To Code An Email Receipt Template With MJML

We are developers, like you. And what we hate above all in coding is to repeat ourselves. So when it comes to writing email templates, we want to provide our users with the best tools to produce content in the most efficient way possible, whether you want to know how to code an e-receipt or just update your welcome emails.

To speed up the development of responsive emails, we’ve already told you about MJML, the open-source email framework we’ve created. If you’re not familiar with it, go check it out right away. You can thank us later.

But even if MJML can help you save quite a lot of time and ease the process, you’ll probably want more. We hear you.

 

A templating language for your transactional emails

Today, flexibility and personalization are a must-have in the email industry. Transactional emails imply more and more complex business logic, and one can often struggle to try to juggle a lot of different templates, when they could just have one personalized email that adapts to several use cases.

Having a separate template for men and another one for women, or creating specific campaigns to recommend different things based on your customer’s previous purchases is not viable. It is in this kind of situations that a templating language comes in handy.

OK, let’s be a bit naive and accept that you could write your own. But to be able to implement a tokenizer and a grammar, you need to have a good knowledge in the field and, at the end of the day, you might just be reinventing the wheel when you could have been focusing on your core business instead…

You could instead use nice libraries such as Handlebars, Jinja or Twig, but then you’ll still need to write or host a dedicated service to handle the templating processing.

Mailjet’s Templating Language

We have the solution. Because at Mailjet we know the value of a fully integrated templating language, we created our own templating language with our Transactional Send API in mind. Our idea: one template to rule them all, just with a single API call.

So, let’s recap: MJML for producing responsive HTML emails without effort, plus a templating language to bring them to life with conditional blocks and variables.

This combo can change your life as a developer. But, enough words, you’ll definitely want some action. So we’ve decided to show you how to create and send awesome transactional emails, step by step.

 

The “How to code” tutorial: what you need to know

We’re rolling out a series of tutorials, all of which will explore a very common use-case, providing numerous examples, code snippets and nice visuals. We’ve even created an easy-to-execute tool, written with NodeJS, to test emails under actual conditions. To use it, you’ll just need valid credentials for both MJML API and Mailjet Transactional Send API, but don’t worry if you’re a newcomer: applying for the MJML API beta and creating a Mailjet account are totally free.

Our “How To Code” series has four parts. Check them out now:

 

How to code a receipt email template: Quick Introduction

From online shoe stores to indie music platforms, any company selling a product online will have to send a receipt. You may think this is a simple task but, actually, there are several elements you’ll need to consider.

Let’s review them briefly, before jumping over to our tutorial, from the more obvious ones to the less:

  1. You will have to loop over the list of items (cart, abandoned cart, recommendations, etc.) and display them.
  2. You need to display the price and may have to do some calculus directly in the email logic (Total, VAT and other taxes). Be careful, as you may use different currencies!
  3. You need to include some basic billing information (billing address, order number, etc.), but you can also provide more personalized information (for instance, you could warn your users that their registered credit card is about to expire).
  4. If there’s shipping, you should display the delivery address.
  5. Your user may have to forward the e-receipt for accounting purposes, so you should ease this workflow.
  6. You can insert marketing content to your receipt, such as a history of previous items or new promotions based on what your user just bought.
  7. If your website supports multiple languages, your emails should too.

Preview of the receipt email template

 

How to code a receipt email template: Over to Github!

Sounds like something you’re already doing? Or are you not sure how to implement some of these elements?

Worry not, we’ll tackle all these needs, and more, in our dedicated Github tutorial for coding email receipt templates with MJML.

On our Github tutorial you’ll find:

  • Detailed explanations.
  • Code samples to implement and adapt.
  • Examples of a receipt email and its different parts.

Ready to see it in action?

Time to jump over to Github.

Github tutorial: How to code a receipt email

 

Embrace Mailjet’s New Multi-Channel Experience With SMS API

Well, fellow API enthusiasts, we just launched something new that should get your attention. Something that pairs perfectly with email. Something that opens up new doors for an improved customer relationship. Something that we, as a transactional solution leader, needed to bring: Short Text Messaging!

Commonly known by the sweet name SMS, it’s one of the most efficient channels of communication that can boost your contact engagement!

As an API wizard, there are two main factors that you usually consider: how useful is this new integration, and how easy is it to implement? We take both these factors into account when developing API solutions, and so after months of hard work, here comes the newest one – our SMS API. This is a feature for those who love simple and effective APIs, allowing you to send SMS all around the world in just 5 lines of code!

Right now, this release is focused on transactional messages, but we aim to evolve these features with new components in the future. As a developer, if you see room for improvement and ways to collaborate with us, your feedback will help us make this feature even greater!

 

So, why is the SMS API useful to you?

Text messaging is one of the most impactful channels for direct communication. According to the Mobilesquared report, 90% of SMS are opened and read within 3 minutes after reception, and 72% of users are interested in receiving transactional SMS.

Given these figures, SMS sending presents a huge opportunity for businesses to engage with their clients.

For instance, you may want to increase security by enabling two-factor authentication for your users, send them useful notifications to increase customer engagement, or display payment confirmations on their phones to verify successful transactions. All of the above benefit from instant sending and a quick way of viewing the messages – and what is quicker than checking your phone to see the SMS you just received?

 

Any requirements before I start sending?

To send SMS messages, you need two things – funds in your SMS wallet and a Bearer token to authenticate your requests.

Token authentication is a different method from the one used for emails, but just as easy. Simply create your token in the front-end, then use the token value in the Authorization header of your payload. For security purposes we don’t keep the token values – once you create it, you need to copy it locally in order to use it.

 

Generate Bearer Token for SMS

 

Time for some code, don’t you think?

We’ve talked enough about the benefits of sending transactional SMS – it’s time to see how it’s done, and what else is possible with Mailjet’s SMS API!

 

Send your SMS

Sending an SMS message is done with a simple HTTP call on the /sms-send endpoint. The payload consists of a JSON body with 3 properties – To (recipient’s phone number), From (customizable sender ID) and Text (the message content).

Nothing to it, right?

 

Detailed Error and Success Payloads

In order to help you quickly find sending issues, we implemented strict checks on your input payload. This means you’ll get synchronous feedback on what went wrong, scaling down your debugging time. See the below example of an error payload:

The success reporting is also quite detailed, providing information about, among other things, the message sender and recipient, Status and Cost.

 

What about Statistics?

You can easily retrieve lists of SMS messages with an HTTP call on the /sms endpoint. You can filter by message delivery status, recipient’s phone number, time period etc.

The response will include a list of messages matching the conditions you have set with the filter values, starting from the most recently created one.

In case you only need the count of the messages, use the /sms/count endpoint instead, and the response will show the number of messages matching your filter settings.

You will also be able to export lists of messages using the /sms/export endpoint.

 

Where can I learn more?

See our dedicated SMS API Guide to learn how to use its capabilities. And, of course, take a look at the SMS API Reference or detailed information on the endpoints, properties and available filters.

 

What’s Next

Glad you asked. Sending transactional messages is just the first step into the SMS world and the beginning of a long series of awesome developments for Mailjet’s API users. Here’s what is on the agenda for the next few months:

  • Beyond Transactional: Additional features to the V1 will allow you to book your own short code for sending SMS and MMS, as well as enhanced tracking and statistics.
  • Marketing campaigns: By building bridges between emails and SMS to manage your contacts or your marketing campaigns, you will be able to engage your customers in a new yet more accurate multichannel experience.
  • Conversational Messaging: 2-way SMS or the possibility to retrieve responses to any SMS you send with us will establish the bedrock for any automated marketing, chat apps or bots.

Facilitated Collaboration And Advanced E-mail Template Management, New At Mailjet!

Ho, ho, ho… No, it’s not Christmas yet, but it’s easy to see why you might think so at Mailjet!

Have you been very nice this year? Probably, because today we have six gifts for you that you can unwrap under the tree (the tree being your Mailjet account – play along ;)).

We are proud to announce the arrival of a bunch of improvements and new features. In a few minutes, you will learn about everything you can now benefit from as soon as you next log in.

A more advanced collaboration with Mailjet

In order to prevent the back and forth in the steps leading to template publication, we have implemented features to let you take on the role of each of your team’s members.

  • 🎁 A lock to secure your favorite sections

Locked Sections

Set which employees can edit a template’s sections to protect the content or your design.

This feature is only available for Premium subscriptions.

  • 🎁 Advanced restrictions for better collaboration

EN-Personalized-Menu

 

Improve collaboration between your teams using advanced settings to define who has the right to block sections, manage your gallery or edit your templates.   

This feature is only available for Premium plans, on Crystal and above.

A more advanced template management

To prevent errors and make it easier to fix them, here are two new features that will put your mind at ease.

  • 🎁 Publication history to go back in time

History-Dashboard-EN

Select the template of your choice and see up to five previous versions published, allowing you to go back to a previous version at any moment.  

  • 🎁 Draft status for your templates

EN-menu-Save-Draft

Save changes to your templates without needing to publish them by using Draft mode. That way, you can work on your Marketing, Automated or Transactional email templates without affecting those already in production. Additionally, you can allow some members of your team to continue working on drafts without granting them the right to publish.

Better organization, effortlessly

Since we know that there is nothing greater than immediately finding what you’re looking for, these features let you gain precious time:   

  • 🎁 Advanced search to find things in the bat of an eyelash

EN-SearchMenu

In your gallery, you now have access to a search field that lets you find templates or template categories by simply typing the name, the desired language or the label of your choosing.

OrderMenu-EN

We also added a new scrolling menu to let you organize your templates the way you like. You can now sort them in alphabetical order, or by last modified or creation date.

  • 🎁 Labels to better organize your template gallery

FR-6-LabelCreated

You can now add labels to your templates to easily find them in your gallery using their color or apply a filter to group them together easily when you are searching for them in the search field.

This feature is only available for Premium subscriptions.

So, isn’t it time to go make a hot chocolate, set your computer on your lap(yes, using it as a heating pad is a well-known trick) and unwrap all your gifts?

Stay tuned – in the next few days, we will present these new features in greater detail so that you can get the most out of them.

Come meet us in person at Mailjet ! :)
While you wait, tell us what you think of your gifts on Twitter and who knows, maybe some new gifts will land under the tree before Christmas ;).

Send API 3.1 Reaches General Availability

We gave you a sneak peek a couple of months ago, but now we’re finally here. The time has come to say goodbye to our beloved Send API version 3, and unveil our most improved version,  v3.1!

Over the past three years, our Send API has been doing a great job at routing all your transactional emails, and thanks to your valuable feedback, we’re now ready to introduce its latest version, which is here to make your sending experience even better.

Ladies and gentlemen, after months of hard work and many valuable lessons learned from our developers community during its beta, Send API 3.1 is ready to become our official and stable version. Cue applause.

Don’t worry, we’ll continue to support Send API 3.0, but we’re sure you’re going to love v3.1!

 

So, why did we decide it was time for a new version?

Let’s be honest, no matter how much we enjoy finding hacks and workarounds, there’s not a developer out there that wouldn’t prefer a pain-free experience while at work. And yes, we know how painful API calls can get, especially when you combine little to no documentation with erratic behaviors, obscure input, response payloads…

So, to make your life easier and your work more manageable, we decided to focus on providing our users with a seamless Send API onboarding journey. We provide you with a complete documentation made by developers for developers, and meaningful payloads to offer a smooth experience.

And to make this new version even more advanced, with a real focus on performance and scalability, we decided to rebuild it entirely from scratch, moving away from our previous code in Free Pascal and opting for a new tech stack based on Golang, Cassandra and Kafka, to name a few. Sounds good, right?

 

Awesome! Show me the code, please?

The first thing you’ll notice is how much the onboarding user experience has improved in this new version. Want to see it in action? Check them out here:

Sending messages

Whether you’re sending one or more messages, it will be as simple as making a single HTTP call on the /v3.1/send endpoint. Send API will accept a JSON payload with a single Messages array property containing up to 100 messages. Clear and easy, isn’t it?

New detailed error and success payloads

Thanks to the feedback we received from our community, we decided it was time for a drastic improvement on our response payloads. We now perform strict checks on all your input payload, which means you’ll receive synchronous feedback about what went wrong, in order to cut down your debugging time. On our side, this also means a reduced number of malformed emails entering our system. Check out this example of an error payload.

Something worth noting is that these errors are generated for each message independently, and only the sending process of the failing messages will be blocked.

Our success reporting is also more detailed than it used to be. Success payloads provide, for instance, a MessageHref property, a URL that points to the API endpoint on which to retrieve the message metadata. Tracking your emails straight from the sending has never been easier.

Both success and error payloads are now sent together, in the same order followed by the input payload messages, to make checking the fail or pass status of your messages much easier.

URL Tagging

Sending emails fast, at scale is one side of the business, but being able to monitor how much they perform is critical. Our mission is to offer you all the tools you need to be able to achieve this. Thanks to Send API v3.1, you can now provide us with the proper tracking markers and we’ll make sure all the links your emails contain are properly tagged and report back to you.

 

Sandbox mode

Sending emails for development purposes comes with a cost (yeah, they still count towards your plan’s email quota), and you’re never fully protected from delivering undesired emails to your customers. Whether you’re experimenting with the API for the first time or just checking your code, there might be times when you’d like to test an email payload without having to send a real email. To make your life easier as a developer, we’ve incorporated a brand new sandbox mode. In your input payload, set SandboxMode to true. This will tell the Send API to process your messages as if you wanted to send them, without actually sending them, so you can properly test and troubleshoot your message easily!