Email Templates and Notifications
The Store SDK contains email templates to send order confirmation, order cancellation, and order shipment notification emails. It also contains email templates for password reset request notifications, password change notifications, and to support shopper email activation scenarios.
The Reference Store application email templates are all generated from JavaServer Page (JSP) files on the Store server Docker container.
Usually a third party email engine is used to compose and send emails to customers.
Setup and configuration
- Download Emerald-crs-web.zip.
- Extract and place the contents into the correct location depending on the
environment.
- For the toolkit environment, extract the contents of downloaded
Emerald-crs-web.zip file into the following folders:
- <WCDE_InstallDir>/workspace/crs-web/WebContent
- <WCDE_InstallDir>/workspace/crs-web/WebContent/WEB-INF/classes
- <WCDE_InstallDir>/workspace/crs-web/WebContent/WEB-INF/spring
- For a production environment, create a WCBD package with the contents of Emerald-crs-web.zip, and then deploy them to your Store server Docker container server Docker container.
- For the toolkit environment, extract the contents of downloaded
Emerald-crs-web.zip file into the following folders:
Working with email templates
All emails have top and bottom banners. These banners can be controlled by business
users through marketing content in Management Center. The top banner is named
EmailBanner_Content
, and the bottom banner is named
EmailBottom_Content
.
- Password reset request notification
- Password change notification
- Shopper email activation
Any aspects of email templates that are not included in the above marketing content must be modified directly by developers. The following is a list of email templates and their respective JSP file locations:
Type | Location |
---|---|
Shopper account activation | <storeDir>\EmailTemplates\User\AccountActivationNotify.jsp |
Password reset request | <storeDir>\EmailTemplates\User\PasswordResetNotify.jsp |
Password changed | <storeDir>\EmailTemplates\User\PasswordChangeNotify.jsp |
Order approval | <storeDir>\EmailTemplates\User\ApproverNotify.jsp |
Order confirmation | <storeDir>\EmailTemplates\Order\OrderCreateNotify.jsp |
Order cancellation | <storeDir>\EmailTemplates\Order\OrderCancelNotify.jsp |
Order shipment | <storeDir>\EmailTemplates\Order\OrderShipmentNotify.jsp |