silverstripers/custom-emails

Send fully configurable custom emails from Silverstripe

dev-master 2024-10-17 08:40 UTC

Requires

• php: >=7.4|>=8
• silverstripe/framework: 4.* | 5.*
• silverstripers/grid-field-switch: *

BSD-3-Clause

• Nivanka Fonseka

• module
• silverstripe
• emails

README

Installation

Use composer to install the module.

composer require silverstripers/custom-emails

Configuration

Define your emails first in YAML files and run a dev build. The emails objects will be created in the CMS (Siteconfig). You can have multiple emails defined with different identifiers.

Once you go in the CMS and configure them you can start sending emails.

---
name: notifications-config
---
SilverStripers\CustomEmails\Dev\Injector:
  definitions:
    EMAIL_IDENTIFIER:
      name: 'Title of the email'
      dynamic: true # for emails which doesnt need a to address
      template: '' # Silverstripe template file to use when rendering emails. 
      arguments: # merge tags
        - Name
        - Email

###Sending emails

To send an email you can use the Processor classs.

use SilverStripers\CustomEmails\Model\NotificationEmail;

$processor = NotificationEmail::get_processor(
    'EMAIL_IDENTIFIER',
    '[e-mail]',
    '[e-mail]',
    [
        'Name' => 'Name',
        'Email' => '[e-mail]'
    ]
);
$processor->setAttachments([
    'file_name' => $content
]);
$processor->send();

The functions above can be used as this.

use SilverStripers\CustomEmails\Model\NotificationEmail;

NotificationEmail::get_processor('EMAIL_IDENTIFIER')
    ->setTo('[e-mail]')
    ->setFrom('[e-mail]')
    ->setData([]) // data as you specify on your merge tags
    ->setAttachments([
        'file_name' => $content
    ])->send();