> ## Documentation Index
> Fetch the complete documentation index at: https://dokumentation.websale.de/llms.txt
> Use this file to discover all available pages before exploring further.

# Emails & email settings

> Overview of all emails sent by the shop and the uniform configuration principle (template, subject, sender address, sender name) per email type.

The WEBSALE shop system sends a wide range of emails for various purposes, for example during checkout, in the customer account, for form inquiries or for notifications.

This page gives an overview of all emails sent by the shop system and describes the uniform configuration principle by which the individual email types can be adjusted (e.g. template, subject and sender data).

***

## Configuration of an email section

The configuration of individual email sections in WEBSALE follows a uniform pattern:

Regardless of whether the email is defined in `actions`, `inquiry`, `messages` etc., template, subject and sender data 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`)

```json theme={"theme":{"light":"github-light","dark":"github-dark"},"languages":{"custom":["/languages/websale.json"]}}
{
  "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 overview

| **Parameter**             | **Type**       | **Description**                                                                                                                                                                                                                                                                                           |
| ------------------------- | -------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `active` / `enabled`      | bool           | Enables/disables dispatch of the email, provided the parameter is present in the respective email configuration. For certain emails (e.g. legally required system emails such as order-received confirmations), disabling is not intended and the parameters `enabled` or `active` are not allowed there. |
| `attachments`             | array (object) | List of file attachments to be sent with the email. For each attachment, provide `name` and `file`. Optional. Not available in every email section.                                                                                                                                                       |
| `fromAddress`             | string         | Sender address used in the email dispatch (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 applicable because dispatch is done dynamically to an email address specified in the shop.                                                                                                                         |
| `merchantEmail`           | string         | Optional way to send an additional notification/copy to a defined merchant address. This parameter is only available for certain emails and not configurable for all emails.                                                                                                                              |
| `template`                | string         | Name of the email template to be used (file name, optionally with a subpath within `mails/`). This controls the content and layout of the email. <br />The `mails/` directory is automatically prepended by the system — see the note below.                                                              |
| `subject` / `mailSubject` | string         | Subject line of the email as it appears in the customer's inbox.                                                                                                                                                                                                                                          |

***

## Email template directory

All email templates are located in the `templates/mails/` directory. This directory is fixed and is automatically prepended to the `template` parameter. Therefore, only specify the file name without the `mails/` prefix.

Example: the template `templates/mails/password_forgotten.htm` is referenced like this.

```json theme={"theme":{"light":"github-light","dark":"github-dark"},"languages":{"custom":["/languages/websale.json"]}}
"email": {
  "template": "password_forgotten.htm",
  "subject": "Passwort zurücksetzen",
  "fromAddress": "noreply@meinshop.de",
  "fromName": "Mein Onlineshop"
}
```

The reason for the missing prefix: since `mails/` is added automatically, an additionally provided `mails/` results in the template not being found. In this case the email is not sent.

The `mails` directory cannot be renamed or moved. It is a fixed special directory of the template structure (see [Template theme](/en/frontend/die-basics/template-theme)).

Custom subfolders within `mails` are not supported for the `template` parameter. A template that is located in a subfolder (for example `templates/mails/login/password_forgotten.htm`) cannot be addressed via the `template` parameter. Therefore place mail templates directly in `mails/`.

***

## Overview of email notifications

Below is an overview of the emails sent by the shop system. These emails can be configured according to the scheme described above (e.g. sender, subject and template).

| **Email**                                                                                                                                                                                                                                                                                                                                  | **Configuration**                                                                                                                                      |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **Order-received confirmation email to the buyer** — Confirmation of order receipt sent 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](/en/konfiguration/actions-fehlertexte-e-mails/actions-warenkorb-checkout#2-3-actions-checkoutconfirm-bestellung-abschließen) |
| **Review reminder email** — Reminder to submit a product review after purchase. Configured in the Admin Interface under *Marketing → Customer reviews*.                                                                                                                                                                                    | [general.productRating](/en/konfiguration/general-allgemeine-shopeinstellungen#general-productrating-product-review) → `reminderEmail`                 |
| **Notification about a new product review (merchant)** — Email to the merchant informing about a newly submitted product review.                                                                                                                                                                                                           | [actions.productRatingAdd](/en/konfiguration/actions-fehlertexte-e-mails/actions-produkte#3-1-actions-productratingadd-produkt-bewerten)               |
| **Double opt-in email for email address change** — Optional double opt-in email before the new email address is applied.                                                                                                                                                                                                                   | [actions.emailUpdate](/en/konfiguration/actions-fehlertexte-e-mails/actions-benutzerkonto#6-1-actions-emailupdate-e-mail-adresse-ändern)               |
| **Confirmation/verify email for email address change** — Confirmation/verify email to the new address (confirmation link).                                                                                                                                                                                                                 | [actions.emailUpdate](/en/konfiguration/actions-fehlertexte-e-mails/actions-benutzerkonto#6-1-actions-emailupdate-e-mail-adresse-ändern)               |
| **Double opt-in email for deleting the customer account** — Optional double opt-in email to confirm the deletion request before execution.                                                                                                                                                                                                 | [actions.accountDelete](/en/konfiguration/actions-fehlertexte-e-mails/actions-benutzerkonto#2-1-actions-accountdelete-kontolöschung)                   |
| **Confirmation of customer account deletion** — Confirmation email that the customer account has been deleted.                                                                                                                                                                                                                             | [actions.accountDelete](/en/konfiguration/actions-fehlertexte-e-mails/actions-benutzerkonto#2-1-actions-accountdelete-kontolöschung)                   |
| **Form receipt confirmation (requester)** — 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](/en/konfiguration/inquiry-formulare#inquiry-formulare)                                                                                  |
| **Registration confirmation (verification email)** — Email to verify the registration or confirm the email address after creating a customer account.                                                                                                                                                                                      | [actions.accountRegister](/en/konfiguration/actions-fehlertexte-e-mails/actions-benutzerkonto#2-3-actions-accountregister-benutzer-registrieren)       |
| **Duplicate detected during registration** — Information sent to an already existing (duplicate) account when a duplicate is detected during registration. In the email template, the address provided during registration is available via `$wsRequestVariables.email` (e.g. so the account admin can create a sub-account for the user). | [accounts.account](/en/konfiguration/accounts-benutzerkonten) → `duplicate.foundEmail`                                                                 |
| **Event-driven / individual notifications** — Additional emails can be defined that are sent when specific shop pages are called up or when defined actions are executed.                                                                                                                                                                  | [messages.emails](/en/konfiguration/messages-ereignisgesteuerte-e-mails#2-messages-emails-ereignisgesteuerte-e-mails)                                  |
| **Back-in-stock notification** — Email to the customer as soon as a previously unavailable item is available again.                                                                                                                                                                                                                        | [content.inventory](/en/konfiguration/content-katalog-kategorien-produkte#beispielkonfiguration-content-inventory)                                     |
| **Stock level notification (low-stock warning)** — Email to the merchant with an overview of items with low stock (up to the configured amount), sent to a defined recipient address.                                                                                                                                                      | [content.inventory](/en/konfiguration/content-katalog-kategorien-produkte#beispielkonfiguration-content-inventory)                                     |
| **Payment failed (customer)** — Email to the customer indicating that the payment for the order has failed. Optionally, this email can additionally be sent as a copy to a configured merchant address (`merchantEmail`).                                                                                                                  | [actions.checkoutConfirm](/en/konfiguration/actions-fehlertexte-e-mails/actions-warenkorb-checkout#2-3-actions-checkoutconfirm-bestellung-abschließen) |

<Info>
  Note: some system emails are legally or functionally required and can therefore not always be disabled.
</Info>