The WEBSALE shop system sends a multitude of emails for different purposes, for example in the checkout, customer account, inquiry forms or notifications.
This page provides an overview of all emails sent by the shop system and describes the unified configuration principle by which the individual email types can be customised (e.g. template, subject and sender details).
Configuring an email section
In WEBSALE, the configuration of individual email sections follows a consistent pattern:
Regardless of whether the email is defined in actions, inquiry, messages, etc., template, subject and sender details are usually controlled via the same basic parameters (e.g. template, subject, fromAddress, fromName).
The following section describes this scheme and shows how an email section is structured and configured.
Example configuration (from actions.checkoutConfirm)
{
"customerEmail": {
"template": "order_confirmation_customer.htm",
"subject": "Ihre Bestellung bei Mein Onlineshop",
"fromAddress": "noreply@meinshop.de",
"fromName": "Mein Onlineshop",
"merchantEmail": "bestellungen@meinshop.de",
"attachments": [
{
"name": "AGB.pdf",
"file": "/files/agb.pdf"
}
]
}
| Parameter | Type | Description |
|---|
active / enabled | bool | Enables/disables sending the email, provided the parameter is present in the respective email configuration. For certain emails (e.g. legally required system emails such as order receipt confirmations), deactivation is not provided for — the enabled or active parameters are not permitted there. |
attachments | array (object) | List of file attachments to be sent with the email. name and file must be specified per attachment. Optional. Not available in every email section. |
fromAddress | string | Sender address used when sending the email (e.g. noreply@mein-shop.de). |
fromName | string | Display name of the sender in the email (e.g. “Mein Onlineshop”). |
mail | string | Recipient address to which the email is sent. For certain emails this parameter is not provided, as the sending is performed dynamically to an email address specified in the shop. |
merchantEmail | string | Optional option to send an additional notification/copy to a defined merchant address. This parameter is only provided for certain emails and is not configurable for all emails. |
template | string | Name or path of the email template to be used. It controls the content and layout of the email. |
subject / mailSubject | string | Subject line of the email as displayed in the customer’s inbox. |
Overview of email notifications
The following is an overview of the emails sent by the shop system. These emails can be configured using the scheme described above (e.g. sender, subject and template).
| Email | Configuration |
|---|
Order receipt confirmation email to the buyer Confirmation of order receipt to the customer. Trigger: order completion / customer. Optionally, this email can additionally be sent as a copy to a configured merchant address (merchantEmail). | actions.checkoutConfirm |
| Review reminder email Reminder to submit a review after purchase. | |
| Notification about new product review (merchant) Email to the merchant informing about a newly submitted product review. | actions.productRatingAdd |
| Double opt-in email on email address change Optional double opt-in email before the new email address is applied. | actions.emailUpdate |
| Confirmation / verify email on email address change Confirmation / verify email to the new address (confirmation link). | actions.emailUpdate |
| Double opt-in email on customer account deletion Optional double opt-in email to confirm the deletion request before it is executed. | actions.accountDelete |
| Confirmation of customer account deletion Confirmation email that the customer account has been deleted. | actions.accountDelete |
Receipt confirmation form (inquirer) Confirmation that the inquiry has been received (e.g. contact form). Optionally, this email can additionally be sent as a copy to a configured merchant address (merchantEmail). | inquiry.form |
| Registration confirmation (verification email) Email to verify the registration or confirm the email address after creating a customer account. | actions.accountRegister |
| Event-driven / individual notifications Additional emails can be defined that are sent when certain shop pages are called or when defined actions are performed. | messages.emails |
| Back-in-stock notification Email to the customer as soon as a previously unavailable item is available again. | content.inventory |
| Inventory notification (low-stock warning) Email to the merchant with an overview of items with low stock (up to the configured count), sent to a defined recipient address. | content.inventory |
Payment failed (customer) Email to the customer with a notice that payment for the order has failed. Optionally, this email can additionally be sent as a copy to a configured merchant address (merchantEmail). | actions.checkoutConfirm |
Note: some system emails are legally or functionally required and may therefore not be deactivatable.
