Skip to main content
The newsletter node bundles everything around newsletter sign-up and sign-off as well as the associated emails. Here you can define, for example, whether a confirmation (double opt-in) is required for various actions and how the email forms are presented and what they should contain.

​
newsletter* - Basic structure

The basic structure of the newsletter node is shown below: 
{
  "newsletter": {
    "field": { },
    "newsletter": { },
  }
}
Parameter description
ParameterDescription
fieldDefines a single field for the newsletter form.
newsletterDefines basic newsletter functions.

​
newsletter.field - Form field for newsletter

The newsletter.field node defines a single field of the newsletter form. This lets you specify, for example, the label, the field type and validations. The frontend renders the input according to these specifications. Example configuration (add “First name” field) 
{
  "newsletter": {
    "fields": {
      "firstName": {
        "name": "firstName",
        "label": "<Textbaustein>",
        "required": false,
        "type": "text",
        "validations": [
          {
            "service": "formCheck.minlen",
            "options": {
              "len": 3
            }
          },
          {
            "service": "formCheck.maxlen",
            "options": {
              "len": 50
            }
          }
        ]
      }
    }
  }
}
Parameter description
ParameterTypeDescription
namestringTechnical name of the form field.
Must be unique and is chosen by you.
Used when submitting the form as well as for import / export.
labelstringDisplay name in the Admin Interface.

requiredboolMarks the field as required.
Default: true
typeenumSpecifies the field type.
Possible values:
- text — free text field.
- salutation — selection of a salutation configured in the shop.
- title — selection of a title configured in the shop.
validationsmultiServiceList of validation rules to check the field content.
Only supported for free text fields (type: text).
More under Validation and check services.
Target: inputValidation

​
newsletter.newsletter - Newsletter settings

The newsletter.newsletter node controls all basic newsletter functions, for example double opt-in and sign-up / sign-off. Templates, subject lines, sender details and much more can be specified. Example configuration 
{
  "blacklistSelfDoubleOptIn": true,
  "doubleOptInEmailBlacklist": {
    "fromAddress": "no-reply@websale.de",
    "fromName": "WEBSALE",
    "subject": "Bestätigen Sie Ihre Blacklist Anmeldung",
    "template": "newsletterBlacklist.htm"
  },
  "doubleOptInEmailSubscribe": {
    "fromAddress": "no-reply@websale.de",
    "fromName": "WEBSALE",
    "subject": "Bestätigen Sie Ihre Registrierung",
    "template": "newsletterSubscribe.htm"
  },
  "doubleOptInEmailUnsubscribe": {
    "fromAddress": "no-reply@websale.de",
    "fromName": "WEBSALE",
    "subject": "Bestätigen Sie Ihre Abmeldung",
    "template": "newsletterUnsubscribe.htm"
  },
  "fields": [
    "newsletter.field.firstName",
    "newsletter.field.lastName",
    "newsletter.field.salutation"
  ],
  "importSubscribeDoubleOptIn": true,
  "unsubscribeAdminDoubleOptIn": true,
  "unsubscribeSelfDoubleOptIn": true,
  "welcomeEmail": {
    "fromAddress": "no-reply@websale.de",
    "fromName": "WEBSALE",
    "subject": "Herzlich Willkommen im Newsletter",
    "template": "newsletterWelcome.htm"
  }
}
Parameter description
ParameterTypeDescription
blacklistSelfDoubleOptInboolIf someone wants to unsubscribe from the newsletter themselves, they must confirm this via a confirmation email (double opt-in).
Default: true
doubleOptInEmailBlacklistobjectSettings for the confirmation email on unsubscribe / block.
fromAddressstringSender email of the confirmation email.
fromNamestringSender name of the confirmation email.
subjectstringSubject of the confirmation email.
templatestringName / file of the email template to be used.
doubleOptInEmailSubscribeobjectSettings for the confirmation email on newsletter sign-up.
fromAddressstringSender email of the sign-up email.
fromNamestringSender name of the sign-up email.
subjectstringSubject of the sign-up email.
templatestringName / file of the email template to be used.
doubleOptInEmailUnsubscribeobjectSetting for the confirmation email on newsletter sign-off.
fromAddressstringSender email of the sign-off email.
fromNamestringSender name of the sign-off email.
subjectstringSubject of the sign-off email.
templatestringName / file of the email template to be used.
fieldsmultiAssocLinked form fields for the newsletter sign-up.
The fields defined under newsletter.field are referenced here.
A separate field for the email address does not have to be specified — it is always automatically passed under the name email.
Target: newsletter.field
importSubscribeDoubleOptInboolImported email addresses must also confirm their newsletter sign-up via a confirmation email.
Default: true
unsubscribeAdminDoubleOptInboolIf an administrator unsubscribes someone from the newsletter, the recipient must confirm the sign-off via a confirmation email.
Default: true
unsubscribeSelfDoubleOptInboolWhen unsubscribing yourself from the newsletter, a sign-off via confirmation email is required.
Default: true
welcomeEmailobjectSettings for the welcome email after successful newsletter sign-up.
fromAddressstringSender email of the welcome email.
fromNamestringSender name of the welcome email.
subjectstringSubject of the welcome email.
templatestringName / file of the email template to be used.