Email Notifications

RMA extension sends emails with different types of notifications to the customer and store agents. You can customize the templates of those emails.

In this section, you will find:

Note: If you need to create your own emails flow, refer to Workflow Rules section.

How to configure Email Notification workflow

Email notifications are governed by the corresponding section of Sales -> RMA -> Settings, as was noted below. There is a short description of the options that are available.

Option Description
Email Sender Sets email from which letters will be sent to a customer.
Template of Notification Email for Customer Template of email notifications for customers.
Template of Notification Email for RMA Owner Template of email notifications for RMA agents.
Template of Rule Notification Template of Workflow Rule email notifications for customers.
Send Email Copy Method If you wish to send a copy of all the RMA messages to a separate email (depends on the setting "Send copy of all emails to") you may select the sending method.
Send a copy of all emails to All outgoing emails will be sent to this list of emails. You should create a comma-separated list of emails.

How to disable Email notifications

To disable Email notifications, you need to go to the Sales > RMA > Settings > Email Notification Settings. In the dropdown list of the necessary notification, select the option Disable these emails. Save configuration.

How to customize the email template

To change the email template of RMA, you need to do the following steps:

  • Go to the Marketing > Email Templates.
  • Press the button Add New Template.
  • In the dropdown list, select the template that you would like to customize. The current extension templates are placed at the Mirasvit_Rma header.
  • Press button Load Template.
  • Enter new Template Name (e.g. Email notification for Customer).
  • Change Template Subject and Template Content as you need, and save the template.
  • Go the to Sales > RMA > Settings > Email Notification Settings. Select your new template in the dropdown list of necessary notifications. Save configuration.

How to use variables in the Email notification

Email templates can contain special variables, which allows a high level of customization.

RMA supports standard Magento Email Template variables, such as {{var logo_alt}}, and supports function calling, like {{var store.getFrontendName()}}, and also adds a set of its own variables.

  • {{var customer}} - allows access to customer properties;
  • {{var rma}} - allows access to RMA properties, including custom fields (see below).
  • {{var getReply()}} - contains a message sent to a customer or staff in RMA discussion.
  • {{var email_body}} - contains a customized at module helper message

Access to properties is similar to Javascript, with dot (.) operator. For example, if we need to include a customer's name to the notifier, we can write {{var customer.name}}. If RMA contains custom fields, they can be accessed by codes which are found at Sales > RMA > Custom Fields > Dictionaries > Custom Fields > Custom Field edit page > Code, in similar manner - if custom field has code customdate, then the variable will be {{var rma.customdate}}.

The most usable properties are:

  • {{var store.getName()}} - name of current store
  • {{var store.getCode()}} - code of current store (e. q. admin for backend, or default for default store)
  • {{var user.getFirstname()}} - First Name of current agent
  • {{var user.getLastname()}} - Last Name of current agent
  • {{var user.getName()}} - Full Name of current agent
  • {{var user.getEmail()}} - Email of current agent
  • {{var rma.getIncrementId()}} - current RMA number
  • {{var rma.getGuestId()}} - displays a Guest ID of current RMA.
  • {{var rma.getUrl()}} - URL of current RMA
  • {{var rma.getBackendUrl()}} - backend URL to RMA page
  • {{var rma.getGuestPrintUrl()}} - URL of the printable version of the current RMA
  • {{var status.getName()}} - current status of RMA
  • {{var customer.getName()}} - Full Name of current customers
  • {{var customer.getEmail()}} - Email of current customer
  • {{var rma.getReturnAddressHtml()}} - address where the package is returned

There is a number of variables that allow you to use your Store Information, as set in Stores -> Configuration -> General -> Store Information

  • {{var storeInfo.getName()}} - name of your store
  • {{var storeInfo.getPhone()}} - phone of current store
  • {{var storeInfo.getCountry()}} - country of your store's location
  • {{var storeInfo.getCity()}} - city, where your store is located
  • {{var storeInfo.getRegion()}} - region, where your store is located (if available).
  • {{var storeInfo.getPostcode()}} - postal code of your location

If Helpdesk is also integrated with RMA, it is possible to use two other variables:

  • {{var hidden_separator}} - allows separating the answer from the communication history
  • {{var hidden_code}} - allows hiding the ticket code in the email template which is used to bind the email with the ticket

You also can use special variables to check, whether particular RMA has items with appropriate Reasons, Conditions and Resolutions. These special variables can be used for creating complex notifications, with sections, dependable from items properties. See more on this matter here:

  • {{var rma.getHasItemsWithReason(XXX)}} - allows to check, whether RMA has items with Reason, which have ID=XXX.
  • {{var rma.getHasItemsWithCondition(XXX)}} - allows to check, whether RMA has items with Condition, which have ID=XXX.
  • {{var rma.getHasItemsWithResolution(XXX)}} - allows to check, whether RMA has items with Resolution, which have ID=XXX.

If necessary, it is possible to use RMA templates standard custom variables. These variables are created with System > Custom Variables and can be inserted with {{customvar code="var_name"}}. For example, if the custom variables have a code "test", then the variable will be {{customvar code="test"}}.