Managing content of emails via CMS blocks

Edit on GitHub
You are browsing a previous version of the document. The latest version is 202204.0.

You can manage the content of emails you send to customers by editing email templates via CMS Blocks.

There is a number of default emails that are automatically sent on different occasions like customer registration or order shipment. You can change the default emails by editing their email templates via respective CMS Blocks. See Default Email Templates for the full list of the emails with their Email CMS Blocks.

To start managing the content of emails, go to Content > Blocks.


Creating an Email CMS Block

If your development team has introduced a new email for your project, you have to create an email CMS Block for it.

Info

You don’t need to create new email CMS Blocks for the default email templates, instead, you edit the available email CMS Blocks to adjust them to your needs.

To create an email CMS Block:

  1. On the Overview of CMS Blocks page, select + Create block.
  2. On the Create CMS block page, select a Template.
  3. Enter a Name.
  4. Click Save. This saves your block and takes you to the page.
Info

On the Create CMS block page, you can ignore all the other fields, including the Store Relation, as they do not affect the behavior of the email templates.

5. Enter the content of your email for all the locales.
Content items

Content Items are not rendered in emails.

  1. Click Save. This populates your email template with the provided content.

  2. Pass the name of the created Email CMS Block to your development team to add to the respective .twig email template.

Note

You don’t need to activate the email CMS Block, as the deactivated status of the email CMS Block does not prevent emails from being sent.

Viewing Email CMS Blocks

You can view an Email CMS block like a regular CMS block. See Viewing CMS Blocks for details.

Editing Email CMS Blocks

To edit an email CMS block:

  1. On the Overview of CMS Blocks page in the Actions column, select Edit Block next to the block you want to update.

  2. On the Edit CMS Block: {Block ID} page, you can update the Name or choose a different Template.

Note

If you updated the name, pass it to your development team to update the name of the respective .twig email template.

  1. Click Save. The page refreshes, displaying the message about the successful update of the Email CMS Block.

Editing Content of Email CMS Blocks

To edit the content of an Email CMS Block:

  1. In the Actions column of the Overview of CMS Blocks page, select Edit Placeholder next to the Email CMS Block you want to update.

  2. On the Edit Block Glossary: {Block ID} page, update the content of the email CMS block. You can use plain text to create content of the emails, or apply glossary keys and variables. See Tips and tricks for details.

Content items

Content Items are not rendered in emails.

  1. Select Save. The page refreshed displaying the message about the successful update.

Tips and tricks

  • Add a glossary key to the Email CMS Block. When the email is sent, the key is replaced with the translation you defined for the locale selected by the customer. See Managing Glossary to learn how to add translations.

  • Add variables to the Email CMS Block to replace them with customer and order specific details. When the email is sent, the variables are replaced with the actual details. For example, add firstName, and it is replaced with the name of the customer the email is sent to. A Developer can provide a full list of variables and create new ones.

What’s next?