Skip to content

Editor field description for the Newsletter configuration

The newsletter configuration is the core element for configuring a newsletter and also generates the registration form.

Tab "General"

General settings, in particular containing administration settings.

Title
(Text input)

Title of the newsletter.

This is also used as prefix in the subject of all E-Mails send to this newsletter.

Description
(HTML editor)

Description of the newsletter.

This is mostly used in emails and content elements for newsletter subscription and unsubscription.

Organizational unit
(Organizational unit selection)
The organizational unit, to which the subscribers of the newsletter belong to. It must be created via the OpenCms user management.
An organizational unit must be selected. In it, subscribers are managed. If you have no select options, you first have to add a suitable organizational unit in the user management. This requires the role "account manager".
User group with send permissions
(Group selection)
Optional - Can occur as often as necessary
Group of users, that are allowed to send emails for the newsletter configuration. If not specified, no special group membership is necessary.
Subscription email
(File selection)
Optional

Select a template for subscription emails.

This option is typically not necessary. If you want to use it anyway, copy the default template, adjust it and link to the adjusted template.

Unsubscription email
(File selection)
Optional

Select a template for unsubscription emails.

This option is typically not necessary. If you want to use it anyway, copy the default template, adjust it and link to the adjusted template.

Tab "Email settings"

Set the sender email for the newsletter mailings.

These settings must be configured.

Sender
Sender of the newsletter emails
Sending address
(Text input)
The email address is invalid.
Reply-to address
(Text input)
The email address is invalid.
Name
(Text input)
Additional recipients
(Text area)
Optional
E-mail addresses to where all e-mails should be send. The recipients can't unsubscribe. Please add one e-mail address per line.

Tab "Layout"

Configure the layout variant for the newsletter. If you have an already existing newsletter and add a new layout variant as first entry, do not delete the old one to ensure that old mailings are still displayable.
Layout configuration
Choice
Optional - Can occur up to 2 times
The configuration of the layout.
Choice option 1
Original Layout
Optional
Header of the email
Configure the header part for the newsletter emails.
Text above image
(HTML editor)
Optional
Text to display above the image using the entire width of the email.
Image
(Image gallery)
Optional

Image to be shown left beside the image text in the email.

If no text beside the image is set, the image is displayed using the entire width of the email.

Text beside image
(HTML editor)
Optional

Text to display beside the image.

If no image is set, the text is displayed using the entire width of the email.

Text below image
(HTML editor)
Optional
Text to display below the image using the entire width of the email.
Custom template
(Text area)
Optional

A customized output template for this part of the email.

The template can use StringTemplate expressions.

Footer of the email
Configure the footer part for the newsletter emails.
Text above image
(HTML editor)
Optional
Text to display above the image using the entire width of the email.
Image
(Image gallery)
Optional

Image to be shown left beside the image text in the email.

If no text beside the image is set, the image is displayed using the entire width of the email.

Text beside image
(HTML editor)
Optional

Text to display beside the image.

If no image is set, the text is displayed using the entire width of the email.

Text below image
(HTML editor)
Optional
Text to display below the image using the entire width of the email.
Custom template
(Text area)
Optional

A customized output template for this part of the email.

The template can use StringTemplate expressions.

??? msg.label.newsletter.config.MailInlineCss ???
(File selection)
Optional
??? msg.label.newsletter.config.MailInlineCss.help ???
Header CSS
(File selection)
Optional
Provide your own CSS styles that are included for the newsletter emails.
Choice option 2
Cöln Layout
Optional
Color configuration
Optional - Can occur as often as necessary
Defines a color configuration.
Color name
(Select box)
The name of the color variable
Color value
(Color picker)
The web value of the color
The colour code must be in the correct hexadecimal format, e.g. in the form ‘#CC3300’.

Tab "Redirects"

Here you can define redirects that are performed after subscription actions.

The configuration is optional and typically not necessary.

Page after subscription
(File selection)
Optional
Page where to redirect to after a subscription request. If not specified, no redirect is performed.
Page after unsubscription
(File selection)
Optional
Page where to redirect to after an unsubscription request. If not specified, no redirect is performed.
Page after subscription confirmation
(File selection)
Optional
Page where to redirect to after a subscription confirmation. If not specified, no redirect is performed.
Page after unsubscription confirmation
(File selection)
Optional
??? msg.label.newsletter.config.RedirectConfirmUnsubscribe.help ???

Tab "Link adjustments"

Here you can adjust link targets in emails. In particular hostnames can be replaced.

The configuration is optional and typically not necessary.

Link adjustment
Optional - Can occur as often as necessary
If the key is found in a link in the newsletter, it is substituted by the value. Use this, e.g., to substitute the hostname if you use a cluster, where the hostname of your page on the workplace server is different from the one on the live server.
Original
(Text input)
Part of the original link that should be replaced.
Replacement
(Text input)
The replacement for the original part of the link.