MailTemplateService.php 22.2 KB
Newer Older
1
2
3
4
<?php

namespace SGalinski\SgMail\Service;

5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
/***************************************************************
 *  Copyright notice
 *
 *  (c) sgalinski Internet Services (https://www.sgalinski.de)
 *
 *  All rights reserved
 *
 *  This script is part of the TYPO3 project. The TYPO3 project is
 *  free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  The GNU General Public License can be found at
 *  http://www.gnu.org/copyleft/gpl.html.
 *
 *  This script is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/
28

29
use DateTime;
30
31
32
use SGalinski\SgMail\Domain\Model\Mail;
use SGalinski\SgMail\Domain\Model\Template;
use SGalinski\SgMail\Domain\Repository\MailRepository;
33
use SGalinski\SgMail\Domain\Repository\TemplateRepository;
34
35
use Swift_Attachment;
use Swift_OutputByteStream;
36
37
use TYPO3\CMS\Core\Cache\CacheManager;
use TYPO3\CMS\Core\Cache\Frontend\FrontendInterface;
38
use TYPO3\CMS\Core\Mail\MailMessage;
39
use TYPO3\CMS\Core\Utility\ExtensionManagementUtility;
40
41
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Extbase\Object\ObjectManager;
42
use TYPO3\CMS\Extbase\Persistence\Generic\PersistenceManager;
43
use TYPO3\CMS\Extbase\Utility\LocalizationUtility;
44
use TYPO3\CMS\Fluid\View\StandaloneView;
45
use TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController;
46

47
48
49
/**
 * MailTemplateService
 */
50
class MailTemplateService {
51
	const MARKER_TYPE_STRING = 'String';
52
53
	const MARKER_TYPE_ARRAY = 'Array';
	const MARKER_TYPE_OBJECT = 'Object';
54
	const DEFAULT_LANGUAGE = 'default';
55
	const DEFAULT_TEMPLATE_PATH = 'Resources/Private/Templates/SgMail/';
56
57
	const CACHE_NAME = 'sg_mail_registerArrayCache';
	const CACHE_LIFETIME_IN_SECONDS = 86400;
58

59
	/**
60
	 * @var array $toAddresses
61
	 */
62
	private $toAddresses = [];
63
64

	/**
65
	 * @var string $fromAddress
66
	 */
67
	private $fromAddress;
68
69

	/**
70
	 * @var array $ccAddresses
71
	 */
Paul Ilea's avatar
Paul Ilea committed
72
	private $ccAddresses;
73
74

	/**
75
	 * @var string $replyToAddress
76
	 */
77
	private $replyToAddress;
78
79

	/**
80
	 * @var string $language
81
	 */
82
	private $language = 'default';
83
84

	/**
85
	 * @var boolean $ignoreMailQueue
86
	 */
87
	private $ignoreMailQueue = FALSE;
88
89
90
91
92
93
94

	/**
	 * @var \TYPO3\CMS\Core\Mail\MailMessage $mailMessage
	 */
	private $mailMessage;

	/**
95
	 * @var string $templateName
96
97
98
	 */
	private $templateName;

99
100
101
102
103
	/**
	 * @var string $subject
	 */
	private $subject;

104
	/**
105
	 * @var string $extensionKey
106
107
108
109
	 */
	private $extensionKey;

	/**
110
	 * @var array $markers
111
	 */
Torsten Oppermann's avatar
Torsten Oppermann committed
112
	private $markers;
113

114
115
116
	/**
	 * @var array $bccAddresses
	 */
Paul Ilea's avatar
Paul Ilea committed
117
	private $bccAddresses;
118

119
120
121
122
123
	/**
	 * @var int
	 */
	private $priority = Mail::PRIORITY_LOWEST;

124
125
126
127
128
	/**
	 * @var int
	 */
	private $pid;

129
130
131
132
133
	/**
	 * @var string
	 */
	private $fromName = '';

134
135
136
	/**
	 * @var \SGalinski\SgMail\Domain\Repository\TemplateRepository
	 */
137
138
139
140
141
142
	protected $templateRepository;

	/**
	 * @var \TYPO3\CMS\Extbase\Persistence\Generic\PersistenceManager
	 */
	protected $persistenceManager;
143

144
145
146
147
148
	/**
	 * @var \TYPO3\CMS\Extbase\Object\ObjectManager
	 */
	protected $objectManager;

149
150
	/**
	 * MailTemplateService constructor.
Paul Ilea's avatar
Paul Ilea committed
151
	 *
152
153
154
	 * @param string $templateName
	 * @param string $extensionKey
	 * @param string $markers
Paul Ilea's avatar
Paul Ilea committed
155
	 * @throws \InvalidArgumentException
156
	 */
157
158
159
160
161
	public function __construct($templateName = '', $extensionKey = '', $markers = '') {
		$this->templateName = $templateName;
		$this->extensionKey = $extensionKey;
		$this->markers = $markers;

162
163
164
165
166
167
		/** @var ObjectManager objectManager */
		$this->objectManager = GeneralUtility::makeInstance(ObjectManager::class);
		/** @var MailMessage mailMessage */
		$this->mailMessage = $this->objectManager->get(MailMessage::class);
		/** @var TypoScriptSettingsService $typoScriptSettingsService */
		$typoScriptSettingsService = $this->objectManager->get(TypoScriptSettingsService::class);
Torsten Oppermann's avatar
Torsten Oppermann committed
168
		$tsSettings = $typoScriptSettingsService->getSettings(0, 'tx_sgmail');
169
170
171
172
		/** @var TemplateRepository templateRepository */
		$this->templateRepository = $this->objectManager->get(TemplateRepository::class);
		/** @var PersistenceManager persistenceManager */
		$this->persistenceManager = $this->objectManager->get(PersistenceManager::class);
173

174
		// use defaultMailFromAddress if it is provided in LocalConfiguration.php; use the sg_mail TS setting as fallback
175
		if (!filter_var($GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromAddress'], FILTER_VALIDATE_EMAIL)) {
176
177
			$this->fromAddress = $GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromAddress'];
		} else {
Torsten Oppermann's avatar
Torsten Oppermann committed
178
			$this->fromAddress = $tsSettings['mail']['default']['from'];
179

Torsten Oppermann's avatar
Torsten Oppermann committed
180
			if (!filter_var($tsSettings['mail']['default']['from'], FILTER_VALIDATE_EMAIL)) {
181
182
				$this->fromAddress = 'noreply@example.org';
			} else {
Torsten Oppermann's avatar
Torsten Oppermann committed
183
				$this->fromAddress = $tsSettings['mail']['default']['from'];
184
			}
185
186
		}

187
		$this->mailMessage->setFrom($this->fromAddress);
188

Torsten Oppermann's avatar
Torsten Oppermann committed
189
190
		$this->bccAddresses = GeneralUtility::trimExplode(',', $tsSettings['mail']['default']['bcc']);
		$this->ccAddresses = GeneralUtility::trimExplode(',', $tsSettings['mail']['default']['cc']);
191
192
193
194
195
196
197
198
199
200
201
202
203

		foreach ($this->bccAddresses as $index => $email) {
			if (!filter_var($email, FILTER_VALIDATE_EMAIL)) {
				unset($this->bccAddresses[$index]);
			}
		}

		foreach ($this->ccAddresses as $index => $email) {
			if (!filter_var($email, FILTER_VALIDATE_EMAIL)) {
				unset($this->ccAddresses[$index]);
			}
		}

204
		if (count($this->bccAddresses) > 0) {
205
206
207
			$this->mailMessage->setBcc($this->bccAddresses);
		}

208
		if (count($this->ccAddresses) > 0) {
209
210
			$this->mailMessage->setCc($this->ccAddresses);
		}
211
212
	}

213
214
215
216
217
218
219
220
221
	/**
	 * Return default markers for sg_mail
	 *
	 * @param string $translationKey
	 * @param array $marker
	 * @param string $extensionKey
	 * @return array
	 */
	public static function getDefaultTemplateMarker($translationKey, array $marker, $extensionKey = 'sg_mail') {
222
		$languagePath = 'LLL:EXT:' . $extensionKey . '/Resources/Private/Language/locallang.xlf:' . $translationKey;
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242

		// Need the key for translations
		if (trim($extensionKey) === '') {
			return [];
		}

		$generatedMarker = [];
		foreach ($marker as $markerName) {
			$generatedMarker[] = [
				'marker' => $markerName,
				'value' => $languagePath . '.example.' . $markerName,
				'description' => $languagePath . '.description.' . $markerName,
				'backend_translation_key' => $translationKey . '.example.' . $markerName,
				'extension_key' => $extensionKey
			];
		}

		return $generatedMarker;
	}

243
	/**
244
	 * Send the Email
245
	 *
Torsten Oppermann's avatar
Torsten Oppermann committed
246
	 * @param boolean $isPreview
247
	 * @return boolean email was sent or added to mail queue successfully?
248
249
250
	 * @throws \TYPO3\CMS\Core\Cache\Exception\NoSuchCacheException
	 * @throws \InvalidArgumentException
	 * @throws \BadFunctionCallException
251
	 * @throws \TYPO3\CMS\Extbase\Persistence\Exception\IllegalObjectTypeException
252
	 */
253
	public function sendEmail($isPreview = FALSE): bool {
254
255
256
257
258
259
260
261
		if (TYPO3_MODE === 'FE') {
			/** @var TypoScriptFrontendController $tsfe */
			$tsfe = $GLOBALS['TSFE'];
			$pageUid = $tsfe->id;
		} else {
			$pageUid = (int) GeneralUtility::_GP('id');
		}

262
263
264
		if ($this->pid) {
			$pageUid = $this->pid;
		}
265
		$siteRootId = BackendService::getSiteRoot($pageUid);
266

267
		/** @var Template $template */
268
		$template = $this->templateRepository->findOneByTemplate(
269
			$this->extensionKey, $this->templateName, $this->language, $siteRootId
270
		);
271

272
273
274
275
276
277
		if ($template === NULL) {
			$template = $this->templateRepository->findOneByTemplate(
				$this->extensionKey, $this->templateName, 'default', $siteRootId
			);
		}

278
279
280
281
282
		// if there is a template, prefer those values
		if ($template) {
			$this->loadTemplateValues($template);
		}

Torsten Oppermann's avatar
Torsten Oppermann committed
283
		$defaultTemplateContent = NULL;
284
285
		// If there is no template for this language, use the default template
		if ($template === NULL) {
286

287
			$templatePath = self::getRegisterArray()[$this->extensionKey][$this->templateName]['templatePath'];
288

289
290
291
292
293
294
			// only standard template file is considered since version 4.1
			$defaultTemplateFile = $templatePath . 'template.html';
			if (file_exists($defaultTemplateFile)) {
				$defaultTemplateContent = file_get_contents($defaultTemplateFile);
			} else {
				return FALSE;
295
			}
296
		} elseif (filter_var($template->getToAddress(), FILTER_VALIDATE_EMAIL)) {
297
			$this->setToAddresses(trim($template->getToAddress()));
298
299
		}

Torsten Oppermann's avatar
Torsten Oppermann committed
300
301
		if ($isPreview) {
			$previewMarker = [];
Paul Ilea's avatar
Paul Ilea committed
302
			/** @var array $markerArray */
303
			$markerArray = self::getRegisterArray()[$this->extensionKey][$this->templateName]['marker'];
Torsten Oppermann's avatar
Torsten Oppermann committed
304
			foreach ($markerArray as $marker) {
305
306
307
308
309
310
311
312
313
314
315
316
				$markerPath = GeneralUtility::trimExplode('.', $marker['marker']);
				$temporaryMarkerArray = [];
				foreach (array_reverse($markerPath) as $index => $markerPathSegment) {
					if ($index === 0) {
						if ($marker['backend_translation_key']) {
							$temporaryMarkerArray[$markerPathSegment] = LocalizationUtility::translate(
								$marker['backend_translation_key'], $marker['extension_key']
							);
						} else {
							$temporaryMarkerArray[$markerPathSegment] = $marker['value'];
						}
					} else {
317
						$temporaryMarkerArray = [$markerPathSegment => $temporaryMarkerArray];
318
					}
319
				}
320
				$previewMarker = array_merge_recursive($previewMarker, $temporaryMarkerArray);
Torsten Oppermann's avatar
Torsten Oppermann committed
321
			}
322
			$this->setIgnoreMailQueue(TRUE);
Torsten Oppermann's avatar
Torsten Oppermann committed
323
324
325
			$this->setMarkers($previewMarker);
		}

326
		/** @var StandaloneView $emailView */
327
		$emailView = $this->objectManager->get(StandaloneView::class);
328

329
		if (NULL === $defaultTemplateContent) {
330
			$emailView->setTemplateSource($template->getContent());
331
			$subject = $template->getSubject();
332
333
		} else {
			$emailView->setTemplateSource($defaultTemplateContent);
334

335
			$subject = self::getRegisterArray()[$this->extensionKey][$this->templateName]['subject'];
336
			if (is_array($subject)) {
337
338
				$subject = self::getRegisterArray(
				)[$this->extensionKey][$this->templateName]['subject'][$this->language];
339
			}
340
		}
341
342
343
344
345

		if ($subject === '' || $subject === NULL) {
			$subject = $this->subject;
		}

346
		$this->mailMessage->setSubject($subject);
347

348
		$emailView->assignMultiple($this->markers);
349
		$emailBody = $emailView->render();
350

351
352
353
		// insert <br /> tags, but replace every instance of three or more successive breaks with just two.
		$emailBody = nl2br($emailBody);
		$emailBody = preg_replace('/(<br[\s]?[\/]?>[\s]*){3,}/', '<br /><br />', $emailBody);
354
355
356
		$isTemplateBlacklisted = self::isTemplateBlacklisted(
			$this->extensionKey, $this->templateName, $siteRootId
		);
357
		if ($this->ignoreMailQueue && !$isTemplateBlacklisted) {
358

359
			$this->mailMessage->setBody($emailBody, 'text/html');
360
			$this->mailMessage->send();
361
			$dateTime = new DateTime();
362
			$currentTimestamp = $dateTime->getTimestamp();
363
364
365
366

			if (!$isPreview) {
				$this->addMailToMailQueue(
					$this->extensionKey, $this->templateName, $subject, $emailBody, $this->priority,
367
					$currentTimestamp, $currentTimestamp, $this->language, $siteRootId
368
369
				);
			}
370

371
		} else {
372
373
			if (!$isPreview) {
				$this->addMailToMailQueue(
374
					$this->extensionKey, $this->templateName, $subject, $emailBody, $this->priority, 0, 0,
375
376
377
					$this->language, $siteRootId
				);
			}
378
		}
379
380

		return TRUE;
381
382
383
	}

	/**
384
	 * Adds a new mail to the mail queue.
385
	 *
386
387
	 * @param string $extensionKey
	 * @param string $templateName
388
	 * @param string $subject
389
	 * @param string $emailBody
390
	 * @param int $sendingTime
391
	 * @param int $priority
392
	 * @param int $lastSendingTime
393
	 * @param string $language
394
	 * @param int $pid
395
396
	 * @throws \InvalidArgumentException
	 * @throws \BadFunctionCallException
Paul Ilea's avatar
Paul Ilea committed
397
	 * @throws \TYPO3\CMS\Extbase\Persistence\Exception\IllegalObjectTypeException
398
	 * @throws \TYPO3\CMS\Core\Cache\Exception\NoSuchCacheException
399
	 */
400
	private function addMailToMailQueue(
401
		$extensionKey, $templateName, $subject, $emailBody, $priority, $sendingTime = 0,
402
		$lastSendingTime = 0, $language = self::DEFAULT_LANGUAGE, $pid = 0
403
	) {
404
		$mail = $this->objectManager->get(Mail::class);
405
		$mail->setPid($pid);
406
407
		$mail->setExtensionKey($extensionKey);
		$mail->setTemplateName($templateName);
408
		$mail->setLanguage($language);
409
		$mail->setBlacklisted(self::isTemplateBlacklisted($extensionKey, $templateName, $pid));
410

411
		$mail->setFromAddress($this->fromAddress);
412
		$mail->setFromName($this->fromName);
413

414
		$mail->setToAddress($this->toAddresses);
415
		$mail->setMailSubject($subject);
416
		$mail->setMailBody($emailBody);
417
		$mail->setPriority($priority);
418
419
		$mail->setBccAddresses($this->bccAddresses);
		$mail->setCcAddresses($this->ccAddresses);
420
		$mail->setSendingTime($sendingTime);
421
		$mail->setLastSendingTime($lastSendingTime);
422
		$mail->setReplyTo($this->replyToAddress);
423

424
		$mailRepository = $this->objectManager->get(MailRepository::class);
425
		$mailRepository->add($mail);
426
		$this->persistenceManager->persistAll();
427
	}
428

429
430
431
432
	/**
	 * Send a Mail from the queue, identified by its id
	 *
	 * @param int $uid
Paul Ilea's avatar
Paul Ilea committed
433
434
	 * @throws \TYPO3\CMS\Extbase\Persistence\Exception\IllegalObjectTypeException
	 * @throws \TYPO3\CMS\Extbase\Persistence\Exception\UnknownObjectException
435
436
437
438
	 */
	public function sendMailFromQueue($uid) {
		$mailRepository = $this->objectManager->get(MailRepository::class);
		/** @var Mail $mailToSend */
439
		$mailToSend = $mailRepository->findOneByUid($uid);
440

441
		if ($mailToSend && !$mailToSend->getBlacklisted()) {
442
			$this->mailMessage->setBody($mailToSend->getMailBody(), 'text/html');
443
			$this->mailMessage->setTo(trim($mailToSend->getToAddress()));
444
445
			$this->mailMessage->setFrom($mailToSend->getFromAddress(), $mailToSend->getFromName());
			$this->mailMessage->setSubject($mailToSend->getMailSubject());
446

447
			if ($mailToSend->getBccAddresses()) {
448
449
450
				$this->mailMessage->setBcc(GeneralUtility::trimExplode(',', $mailToSend->getBccAddresses()));
			}

451
			if ($mailToSend->getCcAddresses()) {
452
453
454
455
456
457
458
				$this->mailMessage->setCc(GeneralUtility::trimExplode(',', $mailToSend->getCcAddresses()));
			}

			if ($mailToSend->getReplyTo()) {
				$this->mailMessage->setReplyTo($mailToSend->getReplyTo());
			}

459
460
			$dateTime = new DateTime();
			$mailToSend->setLastSendingTime($dateTime->getTimestamp());
461
			$this->mailMessage->send();
462
			$mailRepository->update($mailToSend);
463
464
465
		}
	}

466
	/**
467
	 * @param string $toAddresses
468
469
	 * @return MailTemplateService
	 */
470
	public function setToAddresses($toAddresses) {
471
		$toAddresses = preg_replace('~\x{00a0}~siu', ' ', $toAddresses);
472
473
		$this->toAddresses = trim($toAddresses);
		$this->mailMessage->setTo(trim($toAddresses));
474
475
476
477
		return $this;
	}

	/**
478
	 * @param string $fromAddress
479
	 * @param string $fromName
480
481
	 * @return MailTemplateService
	 */
482
	public function setFromAddress($fromAddress, $fromName = '') {
483
484
485
486
487
		if ($fromAddress) {
			$this->fromAddress = $fromAddress;
			$this->mailMessage->setFrom($fromAddress, $fromName);
		}

488
489
490
491
		return $this;
	}

	/**
492
	 * @param string $ccAddresses
493
494
	 * @return MailTemplateService
	 */
495
	public function setCcAddresses($ccAddresses) {
496
497
		if ($ccAddresses) {
			$this->ccAddresses = $ccAddresses;
498
			$this->mailMessage->setCc(GeneralUtility::trimExplode(',', $this->ccAddresses));
499
500
		}

501
502
503
504
		return $this;
	}

	/**
505
	 * @param string $replyToAddress
506
507
	 * @return MailTemplateService
	 */
508
	public function setReplyToAddress($replyToAddress) {
509
510
511
512
513
		if ($replyToAddress) {
			$this->replyToAddress = $replyToAddress;
			$this->mailMessage->setReplyTo($replyToAddress);
		}

514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
		return $this;
	}

	/**
	 * @param string $language
	 * @return MailTemplateService
	 */
	public function setLanguage($language) {
		$this->language = $language;
		return $this;
	}

	/**
	 * @param boolean $ignoreMailQueue
	 * @return MailTemplateService
	 */
	public function setIgnoreMailQueue($ignoreMailQueue) {
		$this->ignoreMailQueue = $ignoreMailQueue;
		return $this;
	}

	/**
	 * @param string $templateName
	 * @return MailTemplateService
	 */
	public function setTemplateName($templateName) {
		$this->templateName = $templateName;
		return $this;
	}

	/**
	 * @param string $extensionKey
	 * @return MailTemplateService
	 */
	public function setExtensionKey($extensionKey) {
		$this->extensionKey = $extensionKey;
		return $this;
	}

553
	/**
554
	 * @param array $markers
555
556
	 * @return MailTemplateService
	 */
557
558
	public function setMarkers(array $markers) {
		$this->markers = $markers;
559
560
		return $this;
	}
561
562

	/**
563
	 * @param string $bccAddresses
564
565
	 * @return MailTemplateService
	 */
566
	public function setBccAddresses($bccAddresses) {
567
568
		if ($bccAddresses) {
			$this->bccAddresses = $bccAddresses;
569
			$this->mailMessage->setBcc(GeneralUtility::trimExplode(',', $this->bccAddresses));
570
571
		}

572
573
574
		return $this;
	}

575
576
577
578
579
580
581
582
	/**
	 * @param int $priority
	 * @return MailTemplateService
	 */
	public function setPriority($priority) {
		$this->priority = $priority;
		return $this;
	}
583
584
585

	/**
	 * @param Swift_OutputByteStream $data
Paul Ilea's avatar
Paul Ilea committed
586
	 * @param string $filename
587
588
589
590
591
592
593
594
595
596
597
	 * @param string $contentType
	 * @return MailTemplateService
	 */
	public function addAttachment($data, $filename, $contentType) {
		$attachment = Swift_Attachment::newInstance()
			->setFilename($filename)
			->setContentType($contentType)
			->setBody($data);
		$this->mailMessage->attach($attachment);
		return $this;
	}
598
599
600
601
602
603
604
605

	/**
	 * @return MailMessage
	 */
	public function getMailMessage() {
		return $this->mailMessage;
	}

606
607
608
609
610
611
	/**
	 * use all values from the given template
	 *
	 * @param Template $template
	 */
	private function loadTemplateValues($template) {
612
613
614
615
616
617
618
619
620
621
622
623
624
625
		$fromName = $template->getFromName();
		if ($fromName === '' && $GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromName']) {
			$fromName = $GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromName'];
		}

		$fromMail = $template->getFromMail();
		if (!filter_var($fromMail, FILTER_VALIDATE_EMAIL)) {
			$fromMail = $GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromAddress'];
			if (!filter_var($GLOBALS['TYPO3_CONF_VARS']['MAIL']['defaultMailFromAddress'], FILTER_VALIDATE_EMAIL)) {
				$fromMail = 'noreply@example.com';
			}
		}

		$this->setFromAddress($fromMail, $fromName);
626
627
628
		$this->setCcAddresses($template->getCc());
		$this->setBccAddresses($template->getBcc());
		$this->setReplyToAddress($template->getReplyTo());
629
		$this->setFromName($fromName);
630
631
632
633
634
635
636
637
		$this->setReplyToAddress($template->getReplyTo());
	}

	/**
	 * @param string $fromName
	 */
	public function setFromName($fromName) {
		$this->fromName = $fromName;
638
	}
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659

	/**
	 * Provides translation for the marker data type
	 *
	 * @param string $markerType
	 */
	public static function getReadableMarkerType($markerType) {
		switch ($markerType) {
			case self::MARKER_TYPE_STRING :
				LocalizationUtility::translate('backend.marker.type.string', 'sg_mail');
				break;
			case self::MARKER_TYPE_ARRAY :
				LocalizationUtility::translate('backend.marker.type.array', 'sg_mail');
				break;
			case self::MARKER_TYPE_OBJECT :
				LocalizationUtility::translate('backend.marker.type.object', 'sg_mail');
				break;
			default:
				LocalizationUtility::translate('backend.marker.type.mixed', 'sg_mail');
		}
	}
660
661
662
663
664
665
666
667
668
669
670

	/**
	 * set the page id from which this was called
	 *
	 * @param int $pid
	 * @return MailTemplateService
	 */
	public function setPid($pid) {
		$this->pid = (int) $pid;
		return $this;
	}
671

672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
	/**
	 * Get all registered templates
	 *
	 * @return array
	 * @throws \TYPO3\CMS\Core\Cache\Exception\NoSuchCacheException
	 * @throws \BadFunctionCallException
	 * @throws \InvalidArgumentException
	 */
	public static function getRegisterArray() {
		/** @var CacheManager $cacheManager */
		$cacheManager = GeneralUtility::makeInstance(CacheManager::class);
		/** @var FrontendInterface $cache */
		$cache = $cacheManager->getCache(self::CACHE_NAME);
		$cacheId = md5('sg_mail');
		/** @var array entry */
		if (($entry = $cache->get($cacheId)) === FALSE) {
			$entry = self::registerExtensions();

			if ($entry === NULL) {
				$entry = [];
			}

			$cache->set($cacheId, $entry, [], self::CACHE_LIFETIME_IN_SECONDS);
		}

		return $entry;
	}

700
701
702
703
704
	/**
	 * Iterate over all installed extensions and look for sg_mail configuration files
	 * If found, register the template(s)
	 *
	 * @throws \BadFunctionCallException
705
	 * @return array
706
	 */
707
	public static function registerExtensions(): array {
708
		// clear registerArray
709
		$registerArray = [];
710
711
712
713
714
715
716
717
718
719

		$extensionList = ExtensionManagementUtility::getLoadedExtensionListArray();

		foreach ($extensionList as $extensionName) {
			$extensionConfigDirectory = ExtensionManagementUtility::extPath($extensionName);
			$extensionConfigDirectory .= '/Configuration/MailTemplates';
			$configFiles = GeneralUtility::getFilesInDir($extensionConfigDirectory);

			foreach ($configFiles as $configFile) {
				$configArray = (include $extensionConfigDirectory . '/' . $configFile);
720
721
722
723
724
725
726
727
728
729
730
731
732
				$extensionKey = $configArray['extension_key'];
				$templateKey = $configArray['template_key'];

				// transform template directory name: your_templates => YourTemplates/
				$templateDirectoryParts = GeneralUtility::trimExplode('_', $configArray['template_key']);
				$templateDirectory = '';
				foreach ($templateDirectoryParts as $part) {
					$templateDirectory .= ucfirst($part);
				}
				$templateDirectory .= '/';
				$templatePath = ExtensionManagementUtility::extPath(
						$extensionName
					) . self::DEFAULT_TEMPLATE_PATH . $templateDirectory;
733

734
735
736
				if ($configArray['template_path']) {
					$templatePath = $configArray['template_key'];
				}
737

738
739
740
741
742
743
744
745
746
747
748
749
750
				$description = $configArray['description'];
				$subject = $configArray['subject'];
				$marker = $configArray['markers'];

				$registerArray[$extensionKey][$templateKey] = [
					'templatePath' => $templatePath,
					'description' => $description,
					'marker' => $marker,
					'extension' => $extensionKey,
					'templateName' => $templateKey,
					'subject' => $subject
				];
			}
751
752
		}

753
		return $registerArray;
754
	}
755
756
757
758
759
760
761
762
763
764
765
766
767

	/**
	 * Checks if a template is blacklisted for a given siterootId
	 *
	 * @param string $extensionKey
	 * @param string $templateName
	 * @param int $siteRootId
	 * @return boolean
	 * @throws \InvalidArgumentException
	 * @throws \BadFunctionCallException
	 * @throws \TYPO3\CMS\Core\Cache\Exception\NoSuchCacheException
	 */
	public static function isTemplateBlacklisted($extensionKey, $templateName, $siteRootId): bool {
768
		$nonBlacklistedTemplates = BackendService::getNonBlacklistedTemplates($siteRootId);
769

770
771
		if ($nonBlacklistedTemplates[$extensionKey]) {
			return $nonBlacklistedTemplates[$extensionKey][$templateName] ? FALSE : TRUE;
772
773
774
775
		}

		return TRUE;
	}
776
777
778
779
780
781
782
783
784
785
786
787
788
789

	/**
	 * @return string
	 */
	public function getSubject(): string {
		return $this->subject;
	}

	/**
	 * @param string $subject
	 */
	public function setSubject(string $subject) {
		$this->subject = $subject;
	}
790
}