Email Templates & Variables

MageRewards uses Magento's transactional email system and comes with a few built-in email templates and email variables. You can always modify the email templates that are sent, or change which email templates are sent based on a loyalty trigger. 

Below is a list of emails and supported email variables for each template:

Transactional Email Templates

  • Customer Referral Invitation

    In a customer's account there is a "My Referrals" section where customers can refer friends. This is the invitation email that is sent to a person who is referred.
    Affiliate/Referral Name {{var affiliate.name}}
    Referred Customer's Name {{var referral.referral_name}}
    Affiliate/Referral Message {{var msg}}
  • Customer Referral New Earnings Notification

     This is the notification email sent to someone whose referral has earned them points.
    Referred name {{var referral.referral_name}}
    Affiliate/Referral Name {{var affiliate.name}}
    Affiliate/Referral Email {{var affiliate.email}}
    Affiliate/Referral URL {{var affiliate_url}}
    Affiliate/Referral Code {{var referral_code}}
    Affiliate/Referral Shortcode {{var referral_shortcode}}
    Amount of Points Earned by the Affiliate/Referral {{var points_earned}}
    Affiliate/referral's points balance {{var points_balance}}
    Affiliate/referral's pending points balance {{var pending_points}}
    Whether or not affiliate/referral has pending points {{var has_pending_points}}
    Comments about the reason for receiving these points {{var msg}}
  • MageRewards - Birthday Points

    If you have birthday points set up this would be the email a customer receives when they earn birthday points
    Customer's Name {{var customer_name}}
    Customer's Email {{var customer_email}}
    Points Transferred {{var points_transferred}}
    Customer's Points Balance {{var points_balance}}
  • MageRewards - Generic Milestone Notification

    The generic template for any milestone rule that is triggered.
    Customer's Full Name {{var customer_name}}
    Customer's First Name {{var customer_firstname}}
    Customer's Email {{var customer_email}}
    Customer's Points Balance {{var customer_points_balance}}
    Customer's Pending Points Balance {{var customer_pending_points}}
    Whether or not Customer has Pending Points {{var customer_has_pending_points}}
    Affiliate/Referral URL {{var customer_affiliate_url}}
    Affiliate/Referral Code {{var customer_referral_code}}
    Affiliate/Referral Shortcode {{var customer_referral_shortcode}}
    Description for Milestone Reached {{var milestone_description}}
    Massage for Milestone Rule {{var milestone_message}}
    Milestone Target {{var milestone_target}}
    Milestone Condition {{var milestone_details_condition}}
    Milestone Action Taken {{var milestone_details_action}}
    Points Amount Awarded for Reaching Milestone {{var milestone_details_points_amount}}
    Points String Awarded for Reaching Milestone {{var milestone_details_points_string}}
    Customer Group ID transitioned to after Reaching Milestone {{var milestone_details_customer_group_id}}
    Customer Group Name transitioned to after Reaching Milestone {{var milestone_details_customer_group_name}}
  • MageRewards - Inactivity Notification

    This is the email that is sent to a customer if you have an inactivity milestone rule set up.
    Customer's Full Name {{var customer_name}}
    Customer's First Name {{var customer_firstname}}
    Customer's Email {{var customer_email}}
    Customer's Points Balance {{var customer_points_balance}}
    Customer's Pending Points Balance {{var customer_pending_points}}
    Whether or not Customer has Pending Points {{var customer_has_pending_points}}
    Affiliate/Referral URL {{var customer_affiliate_url}}
    Affiliate/Referral Code {{var customer_referral_code}}
    Affiliate/Referral Shortcode {{var customer_referral_shortcode}}
    Description for Milestone Reached {{var milestone_description}}
    Massage for Milestone Rule {{var milestone_message}}
    Milestone Target {{var milestone_target}}
    Milestone Condition {{var milestone_details_condition}}
    Milestone Action Taken {{var milestone_details_action}}
    Points Amount Awarded for Reaching Milestone {{var milestone_details_points_amount}}
    Points String Awarded for Reaching Milestone {{var milestone_details_points_string}}
    Customer Group ID transitioned to after Reaching Milestone {{var milestone_details_customer_group_id}}
    Customer Group Name transitioned to after Reaching Milestone {{var milestone_details_customer_group_name}}
  • MageRewards - Points Expiry Notice (Warning #1)

    the first reminder sent to a customer before their points expire. They need to earn more points or spend more points to keep them.
    Customer's Name {{var customer_name}}
    Customer's Points Balance {{var points_balance}}
    Number of Days until Expiry {{var days_left}}
  • MageRewards - Points Expiry Notice (Warning #2)

    The second, and final, reminder email sent to a customer before their points expire. They need to earn more points or spend more points to keep them.
    Customer's Name {{var customer_name}}
    Customer's Points Balance {{var points_balance}}
    Number of Days until Expiry {{var days_left}}
  • MageRewards - Points Summary Statement

     This is an optional monthly statement that is sent out to all customers who have points. 
    Customer's Name {{var customer_name}}
    Customer's Email {{var customer_email}}
    Store Name {{var store_name}}
    Customer's Points Balance {{var points_balance}}
    Whether or not Customer has Pending Points {{var has_pending_points}}
    Customer's Pending Points Balance {{var pending_points}}
    Unsubscribe URL for Points Summary Statements {{var unsubscribe_url}}
  • MageRewards - Send Points to a Friend - Invitation

    If you have "Send Points to a Friend" functionality enabled on the front end, this is the email template that is sent when a customer sends points to their friend
    Customer's Name {{var customer_name}}
    Customer's Email {{var customer_email}}
    Friend's Email {{var friend_email}}
    Store Name {{var store_name}}
    Amount of Points Transfered {{var points_transferred}}
  • MageRewards - Send Points to a Friend - Notification

    If you have "Send Points to a Friend" functionality enabled on the front end, this is the email template that is sent when a customer's friend accepts the points.
    Customer's Name {{var customer_name}}
    Customer's Email {{var customer_email}}
    Friend's Email {{var friend_email}}
    Friend's Name {{var friend_name}}
    Store Name {{var store_name}}
    Amount of Points Transfered {{var points_transferred}}
    Transfer Comment {{var comment}}

Global Points Balance Variable

As of MageRewards v1.8.9.0 we added a global variable for customer's points balance which can be used on all Magento transactional email templates.

  • {{stbalance customer_id=140}}
  • {{stbalance customer_id=$customerVariable.id}}
  • {{stbalance email="customeremail@xyz.com"}}
  • {{stbalance email=$customerEmailVariable}}

Magento Transactional Emails Examples:

  • New Order
    • Your points balance is {{stbalance email=$order.customer_email}}
  • New Invoice
    • Your points balance is {{stbalance email=$order.customer_email}}
  • New Shipment
    • Your points balance is {{stbalance email=$order.customer_email}}
  • New Account
    • Your points balance is {{stbalance email=$customer.email}}
    • Your points balance is {{stbalance customer_id=$customer.id}}
  • Newsletter Subscription Success
    • Your points balance is {{stbalance email=$subscriber.email}}

Still need help? Get Help Get Help