Customizing Email Templates

Merchants can fully customize the customer notification email. It can include plain text, static HTML, and even dynamic information with the help of the full fledged template engine.

NVelocity is used as the template engine to process the email templates. Templates are written in velocity template language (VTL), which is extremely simple and powerful.

In a velocity template, certain objects put in the velocity context, can be accessed directly in a straight forward manner. For example if a ‘Store’ object, named “store” is available in the context, then using $store.Name we will get the name of the store. Similarly any method available in the ‘Store’ object can be called directly.

While writing templates for email messages in AbleCommerce, certain objects are automatically made available to the context, depending on the type of event.

The following table illustrates the objects and their availability for different events.

Object            Type              	            Available To
----------------------------------------------------------------------------------------------------

store             CommerceBuilder.Stores.Store     All Events

order             CommerceBuilder.Orders.Order     OrderStatusUpdated, PaymentAuthorized,
                                                   PaymentCaptured, PaymentCapturedPartial,
                                                   PaymentAuthorizationFailed,
                                                   PaymentCaptureFailed, OrderPlaced, OrderCancelled,
                                                   OrderPaidPartial, OrderPaid, OrderPaidNoShipments,
                                                   OrderPaidCreditBalance, ShipmentShipped, 
                                                   OrderShipped, OrderShippedPartial,  
                                                   GiftCertificateValidated, OrderNoteAddedByCustomer

customer          CommerceBuilder.Users.User       OrderStatusUpdated, PaymentAuthorized,
                                                   PaymentCaptured, CustomerPasswordRequest,  
                                                   PaymentCapturedPartial, 
                                                   PaymentAuthorizationFailed,
                                                   PaymentCaptureFailed, OrderPlaced, OrderCancelled,
                                                   OrderPaidPartial, OrderPaid, OrderPaidNoShipments,
                                                   OrderPaidCreditBalance, ShipmentShipped, 
                                                   OrderShipped,OrderShippedPartial, 
                                                   GiftCertificateValidated, OrderNoteAddedByCustomer

oldstatusname     System.String                    OrderStatusUpdated

products          CommerceBuilder.Products.Product LowInventoryItemPurchased

payment           CommerceBuilder.Payments.Payment PaymentAuthorized, PaymentCaptured,
                                                   PaymentCapturedPartial, 
                                                   PaymentAuthorizationFailed,
                                                   PaymentCaptureFailed
resetPasswordLink System.String                    CustomerPasswordRequest

shipment          CommerceBuilder.Shipping.        ShipmentShipped
                  OrderShipment

giftcertificate   CommerceBuilder.Payments.        GiftCertificateValidated 
                  GiftCertificate

note              CommerceBuilder.Orders.OrderNote OrderNoteAddedByCustomer