pluswerk/mail-logger

+Pluswerk TYPO3 extension: Mail Logger

Installs: 10 546

Dependents: 0

Suggesters: 0

Security: 0

Stars: 2

Watchers: 7

Forks: 3

Open Issues: 2

Type:typo3-cms-extension

2.0.1 2021-02-23 10:29 UTC

This package is auto-updated.

Last update: 2021-03-23 10:36:56 UTC


README

Packagist Release Travis GitHub License Code Climate Build Status

+Pluswerk TYPO3 extension: Mail Logger

This is an TYPO3 extension with some mail functions:

  1. E-mail logging
  2. E-mail templates
  3. E-mail debugging

Extension installation

Install via composer or just copy the files into the TYPO3 extension folder:

composer require pluswerk/mail-logger

Go to the TYPO3 backend, activate the extension and add the TypoScript to the page template. Now everything is set-up and ready for you to create your own mailing settings in TypoScript.

1. E-mail logging

The extension automatically log all outgoing mails of the TYPO3 system, which are sent via the TYPO3 mail API. Just install the extension and it works. All outgoing mails can be found in the backend module of this TYPO3 mail logger.

By default the maximum logging time of e-mails is 30 days and can be changed as following: see strtotime The mails will be anonymized after 7 days by default. It can be changed to anonymize directly, by setting anonymizeAfter to 0.

module.tx_maillogger.settings.cleanup {
  lifetime = 30 days
  anonymize = 1
  anonymizeAfter = 7 days
}

2. E-mail templates

You can configure TYPO3 e-mail templates, written in Fluid, which are editable from editors (in the database) and configured via TypoScript (in VCS).

How does this work? E-mails will be basically configured in a TypoScript configuration (configuration of the sender address for example). Afterwards a database entry will be generated from the editor, which extends this template with additional information (fluid template or receiver for example). The instance of such an e-mail can be extended or overridden afterwards via php in your own extension (for example: dynamic receiver).

TypoScript example

You always have to create a TypoScript template for a mail. The "label" is the only required field, the orher fields are optional.

# E-mail template
module.tx_maillogger.settings.mailTemplates {
    exampleMailTemplateKey {
        label = This Label will be shown in the Backend for BE-Users, replace this with a good title! :-)
        mailFromName = Default Mail-From-Name
        mailFromAddress = info@domain.com
        mailToNames = Markus Hoelzle, John Doe
        mailToAddresses = markus-hoelzle@example.com, john.doe@example.com
        mailBlindCopyAddresses = we-read-all-your-mails@example.com
    }
}

E-mail templates in database

E-mail templates will be stored in the database. Just create a record "E-mail template". The TypoScript template will be selected there. The message will be rendered by Fluid, so it is possible to print variables or use ViewHelpers.

Example message:
<f:format.nl2br>
  Hello,
  
  we have {amount} new purchase keys (see attachment).
  
  This mail was sent automatically by domain.com
</f:format.nl2br>

sending E-mails via PHP

E-mail instances "\Pluswerk\MailLogger\Domain\Model\Mail\TemplateBasedMailMessage" inherit from SwiftMailer class "\Swift_Message". Therefor an e-mail instance have got following functions: http://swiftmailer.org/docs/messages.html The easiest way is to use the functions of the "\Pluswerk\MailLogger\Utility\MailUtility" class.

basic sample:
<?php
use \Pluswerk\MailLogger\Utility\MailUtility;
MailUtility::getMailByKey('exampleMailTemplateKey', null, ['myVariable' => 'This mail was sent at ' . time(), 'myUser' => $myExtbaseUser])->send();

E-mail template in certain language

<?php
use \Pluswerk\MailLogger\Utility\MailUtility;
MailUtility::getMailByKey('exampleMailTemplateKey', 42, ['myVariable' => 'This mail was sent at ' . time(), 'myUser' => $myExtbaseUser])->send();

example - passing E-mail parameters and sending attachment (FPDF for example)

<?php
use \Pluswerk\MailLogger\Utility\MailUtility;
try {
    // send mail
    $mail = MailUtility::getMailByKey('exampleMailTemplateKey', null, [
        'amount' => $amount
    ]);
    $pdfFileName = 'myFile.pdf';
    $pdfFileByteStream = $fpdf->Output($pdfFileName, 'S');
    $pdfFileAttachment = \Swift_Attachment::newInstance($pdfFileByteStream, $pdfFileName, 'application/pdf');
    $mail->attach($pdfFileAttachment);
    $mail->send();
} catch (\Exception $e) {
    // handle error
    $this->addFlashMessage('E-Mail could not be sent because of an error: ' . $e->getMessage(), '', AbstractMessage::ERROR);
}

You should always catch exceptions in your php code. Experience has shown that editors often don't add a template (or translation) etc. Corresponding errors should somehow be handled!

Custom fluid templates

Sometimes you additionally want to wrap the mail templates from database with your own markup. Therefore we provide the option to customize the mail for your needs via fluid. Again - via Typoscript - you can configure a rendering definition for every mail template.

module.tx_maillogger.settings.templateOverrides {
    mytemplatekey {
      title = My Template
      templatePath = EXT:my_ext/Resources/Private/Templates/Mail.html
      partialRootPaths = EXT:my_ext/Resources/Private/Partials/
      layoutRootPaths = EXT:my_ext/Resources/Private/Layouts/
    }
    anothertemplatekey {
      title = Another Template Key
      templatePath = EXT:another_ext/Resources/Private/Templates/Mail.html
      settings {
        myParameter = myValue
      }
    }
  }
}
<!-- Fluid example -->
<h2>{mailTemplate.subject}</h2>
<f:format.raw>{message}</f:format.raw>
<p>This is my passed value: {settings.myValue}</p>

The Variables "message" and "mailTemplate" are automatically provided to your template. You can use the actual message by simply wrapping it with a "f:format.raw"-viewhelper. You can provide your own partial- and layout-paths for every template you add. Alternatively it will use the default paths provided by this extension.

You can add your own parameters to the template via "settings"-option.

example - Use a e-mail template in your own plugin

If a mail template can be selected dynamically by the editor, you can integrate a Flexform in the plugin, adding the following configuration:

<settings.userMailTemplate>
    <TCEforms>
        <label>E-mail template</label>
        <config>
            <type>select</type>
            <renderType>selectSingle</renderType>
            <foreign_table>tx_maillogger_domain_model_mailtemplate</foreign_table>
            <foreign_table_where> ORDER BY tx_maillogger_domain_model_mailtemplate.title</foreign_table_where>
            <size>1</size>
            <minitems>1</minitems>
            <maxitems>1</maxitems>
        </config>
    </TCEforms>
</settings.userMailTemplate>

DKIM signing of mails (NOT SUPPORTED IN VERSION 2.0 until now)

You can set a DKIM-signing for every mailtemplate you use for spam protection reasons. Therefore you have to define typoscript keys which you can select in the backend of a mail template.

Please note that you have to strip "-----BEGIN RSA PRIVATE KEY-----" and "-----END RSA PRIVATE KEY-----", as they are added from php with special chars you don't want to type via typoscript. So only paste your private keychain as key.

For an example regarding using DKIM signing and adding the TXT-records to your DNS you can visit this article

Key: Your private key without "-----BEGIN RSA PRIVATE KEY-----" and "-----END RSA PRIVATE KEY-----" Domain: The domain from which you want to send your mail (e.g. info@example.com) Selector will most likely remain "default".

module.tx_maillogger.settings.dkim {
    examplekey {
      key = MYRSAPRIVATEKEY
      domain = example.com
      selector = default
    }
}

3. E-mail debugging

All emails can be viewed in the backend module. Alternatively, all e-mails can be redirected to a specific e-mail address via this TypoScript setting. This can be used to debug outgoing mails in TYPO3:

module.tx_maillogger.settings.debug {
    # Redirect all mails from mail_logger to specific mail addresses
    mail {
        # Set enable to '1' to enable this mail debug feature
        enable = 0

        # Specify your ip (comma separated) or set to all '*'
        ip = 127.0.0.1, 123.123.123.123
        #ip = *

        # Set the mail addresses (comma separated) to which the mails should be redirected
        mailRedirect = test@domain.com, a@b.de
    }
}