Configure Email Content

Configure email content

To configure email content, follow these steps.

  1. In the Content section, click Add creative.
  1. Navigate to the Email tab.
  2. To use an existing template, select the template from the list.
  3. To create a new message, click Create New.

Creating a new email

  1. To create a new message, click Create New.
  2. Select your preferred option from the following.

a. Upload zip file:

  • Select Upload zip file, then click Upload.
  • Browse a file (format: .zip, .html, .htm), and then click Continue.
  • In the email body modify the text and formatting, add images and labels, and then click Create. You can also use Liquid language in the messages. You can use Liquid language to send personalised messages, messages based on conditions, product recommendations based on last purchase, etc. For more information, refer to the detailed documentation on Liquid language

❗️

Note

Make sure that all tags contain data. Inconsistency in the tags will result in a validation error.

You can also use the organization custom field to use dynamic header, footer etc according to the organization. This can help in a connected org set-up. Refer to the documentation here.

📘

Notes

  • You can also create email content from Create message section.
  • Unsubscribe tag is compulsory to include. To know more about each tag, see Message content section.
  • You can upload a file with a size limit of up to 5MB.

b. Create using the editor:

  • Select Create using editor, then click Continue.
  • Click the appropriate Select option - either to Select start from scratch or select on the appropriate template.

If you select start from scratch follow the given steps:

  • In Subject, enter the email subject.
  • In the email body; modify the text and formatting, add images and labels, and then click Create.

📘

Notes

  • You can also create email content from the Create message section.
  • Unsubscribe tag is compulsory to include. To know more about each tag, see Message content section. You can raise a Jira ticket, if you want this to be optional.
  • Click Preview to preview the email content and design before sending.
  • Click Test message to test the message by sending it to your preferred email IDs or test user group before sending it to the actual recipients. Add email IDs or test groups accordingly.
  • Rows tab
    To design the layout, click the Rows tab on the right panel, drag, and drop it to your preferred position on the mail body. Similarly, you can add more rows as required.

📘

Note

There are various rows available each with a different dimension.

  • Content tab
    Use the Content tab to add text, images, buttons, divider, social network links, HTML code, videos, and more to the email body (each row). Drag and drop the required content block to the desired position in the body. You can also include a barcode which will have the customer's loyalty identification information. This can be included in the email during a customer registration email or any other updates or campaigns in the email. For more information on barcodes, refer to the barcode documentation.

Content Blocks

BlockDescription
TitleTo include a title.
ParagraphTo add text. This is similar to the text block.
ListTo add a list.
TextTo include a text message.
ImageTo add images from the library or your local system.
ButtonTo add action buttons such as Click here, Submit.
DividerTo add columns to a row (divide a row into columns).
SocialInclude Social Channel icons to navigate recipients to the organization's social platforms. You need to link the respective URLs for each social channel icon (Facebook, Twitter, Instagram, and LinkedIn).
HTMLTo insert HTML code blocks in the template. For example, HTML tags, headers, hyperlinks, and more.
VideoTo embed a video in the email. Add a video embed link in the input box. For example, you can embed a video representing specific information about the brand or product or brand ad.
IconTo add an image icon in the email body. An icon, a small image, or a symbol is usually used for the brand or product logos. \<br>\ Add an icon from the library and modify it as required.
MenuTo insert a menu bar in the email body. A menu is a navigation bar with links to each menu option. You can configure multiple menu items if required.
StickersTo include stickers from the library.
GIFSTo add animated images or GIFS from the library.

Block Options

Content PropertiesDescription
PaddingUse to add an additional margin to the content on all sides (Overall) or each side of a box - Right, Left, Top, and Bottom.
Hide onHide on feature enables you to show the content on your preferred form factor. You can choose to hide content either on desktop or mobile.
  • Toggle between code view and normal view
    To switch to the code or editor mode, hover the mouse and click Switch editor.

📘

Note

In code mode, you can only see editor design email using HTML code. Repeat the previous step to switch back to Drag-N-Drop editor mode.

📘

Note

After selecting the content block, you can view all the content properties and block options to modify the content.
For example, Font style, Font color, Bold, Italics, Alignment, Add bullets, etc.

Preview and Test mode

You can use the preview and test options to verify the email's content and design before sending it to your audience.

  • Preview: Use to view the email content and design in advance before saving the message..
  • Test message: You can send a text message to a test group to review the content and design before sending it to the actual audience. You can send it to your preferred email IDs or to a test user group.

Troubleshooting email image quality issues

👍

Notes

  • Do not forcefully enlarge images.
  • Use actual images or image URLs in zip files without enlarging them.
IssueResolution
File size is getting reducedExpected behavior. File size reduction due to image transformations does not affect user experience. Specify image dimensions to maintain quality. <br>For example, if the email specifies a height and width of 200 x 300, images are transformed to match these dimensions instead of saving the original image, which might have very high dimensions. Consequently, the file size is reduced. This reduction could also occur due to dynamic image quality adjustments based on file sizes.
Image getting compressed excessivelyCompression varies with file size. Smaller images have less compression; larger images undergo higher compression. This makes sure that irrespective of the file size, similar quality of images is achieved after compression. Do not artificially enlarge images to increase the file size.
Images saved in avif format instead of jpegImages are saved in their actual format except when the device supports avif format. avif format enables saving the images in smaller file sizes without impacting image quality.

For information on Generate OTP APIs, refer to the API documentation.

Barcode in Email

This feature enables you to create a barcode that contains customer identifier information and can be used by customers for identification purposes. Customers can use this barcode at the POS to identify themselves and earn/claim loyalty benefits.

📘

Note

  • Barcode feature is not enabled by default. Create a JIRA ticket to the sustenance team to enable the feature.
  • Barcode feature can be used both in Loyalty programs and on Engage+.

Prerequisties to enable barcode

  1. To enable barcode generation, the following configurations must be enabled:

    1. CONF_REGISTRATION_BARCODE_GEN_ENABLED: Set the value to 0 or 1. Default value: 0- False
    2. CONF_BARCODE_VALUE_IDENTIFIER: Set the value to 0,1 or 2 to set the barcode identifier. You can set the identifier according to the information to embed in the barcode.
ValueDescription
0Mobile number of the customer.
1Email ID of the customer.
2The external ID of the customer.
  1. Raise a Jira ticket assigned to the Foundation team and enable bucket, namespace, and CDN URL support for the barcode service on the respective cluster where the organization is located.

Configuring barcode

Capillary supports six types of barcodes, given below:

  • ITF
  • PDF417
  • EAN 13
  • UPC A
  • QR code
  • CODE 128

Default barcode configuration

Field

Value

Default barcode type

CODE_128

Image type

PNG

Default barcode styles<br>according to the barcode type:

-ITF

  • Barcode text: Disabled[<br>-Image height: 200<br>- Image width: 400

-QR_CODE

  • Barcode text: Disabled\<br>- Image height: 200\<br>- Image width: 300<br>- Image width padding: Enabled<br>- Image height padding: Enabled

-PDF_417

  • Barcode text: Disabled<br>- Image height: 200 <br>- Image width: 300<br>- Image width padding: Enabled<br>- Image height padding: Enabled<br>- Font size: 5

-EAN_13

  • Barcode text: Disabled<br>- Image height: 200<br>- Image width: 300<br>- Image width padding: Enabled<br>- Image height padding: Enabled<br>- Font size: 5

-UPC_A

  • Barcode text: Enabled<br>- Image height: 200<br>- Image width: 300<br>- Image width padding: Enabled<br>- Image height padding: Enabled<br>- Font size: 5<br>- Font name: Arial

-CODE_128

  • Barcode text: Disabled<br>- Image height: 200<br>- Image width: 300<br>- Image width padding: Enabled<br>- Image height padding: Enabled<br>- Font size: 5<br>- Font name: Arial
FieldData TypeDescription
default_barcodeStringDefault barcode type that will be used if no barcode type is mentioned in the barcode service API.
showBarcodeTextBooleanIf set to true, the text will be displayed with config.
imageHeightIntegerHeight of the image in pixels.
imageWidthIntegerWidth of the image in pixels.
imageWidthPaddingIntegerPadding around the width of the barcode image. This property is applicable when showBarcodeText is set to true. Not applicable for ITF barcode.
imageHeightPaddingIntegerPadding around the length of the barcode image. This property is applicable when showBarcodeText is set to true. Not applicable for ITF barcode.
fontNameStringName of the font. Not applicable for EAN 13, PDF417, QR Code, ITF barcode.
fontSizeStringSize of the font. Not applicable for ITF and QR code.

To edit the default barcode configuration, create a JIRA ticket to the Capillary sustenance team.

Generating barcode

According to the configuration, during customer registration, the Customer Add API calls the barcode service and the barcode image is stored in the images table in the backend. If the identifier provided in the configuration is changed using customer identifier change API, a new barcode image is created and saved. You can retrieve the barcode image details using the GET customer details API.

📘

Note

If you want to create a barcode for an existing user or regenerate a barcode, create a ticket to the Sustenance team.

To embed the barcode in the email creative, perform the following:

  1. Navigate to the Engage+ homepage, and select the campaign to send the email creative.
  1. Click New message to create a new email creative.
  1. In the Content block, click Add creative.
  1. Navigate to the Email tab and click Create new.
  1. Click Create using editor and click Continue.
  1. Select a template of your choice.
  1. In the email body, click Add label and select Customer barcode label.
  1. Embed the {{customer_barcode}} tag in your email template.

A barcode has been generated for the customer. A broken image is sent to the customer if a barcode fails to generate.