moritz-sauer-13 / silverstripe-templated-emails

2.0.0 2025-12-02 14:20 UTC

Requires

• silverstripe/recipe-cms: ^6

Unknown License

• Moritz Sauer

Published on Packagist.org on 2025-12-02 14:21 UTC

README

A SilverStripe module that provides a unified, theme‑ready email template and automatically renders form data as a table—no manual HTML needed.

Installation

1. Install the package (in your project directory):

   composer require moritz-sauer-13/silverstripe-templated-emails
   

2. Update database/manifest:

   • run /dev/build?flush=all

Requirements: SilverStripe CMS 5.x

Quick start

use SilverStripe\Control\Email\Email;
use TemplatedMails\Model\TemplatedEmail;

$email = TemplatedEmail::create()
    ->setTo('[e-mail]')
    ->setFrom(Email::config()->admin_email)
    ->setSubject('Contact request')
    ->setGreeting('Hello,')
    ->setTitle('New contact request')
    ->setFormData($data, $form);

$email->send();

• If a $form is provided, the order and labels are derived from the form fields.
• Additional free text/HTML can still be set via $email->setBody() and rendered in the template with $EmailContent.RAW.

Configuration (YAML)

Keys and defaults:

• skip_empty: true — Skip empty fields (default)
• excludes: ["SecurityID", "url", "g-recaptcha-response"] — Exclude exact key names
• excludeprefixes: ["action"] — Exclude all keys starting with any of these prefixes
• array_separator: ", " — Separator for array values
• label_from_placeholder: true — Use placeholder as label when Title is empty
• strip_required_asterisk: true — Remove trailing asterisk on required field labels

Example app/_config/email.yml:

TemplatedMails\Model\TemplatedEmail:
  skip_empty: true
  excludes:
    - SecurityID
    - url
    - g-recaptcha-response
  exclude_prefixes:
    - 'action_'
  array_separator: ', '
  label_from_placeholder: true
  strip_required_asterisk: true