MailTemplateService.php 20.9 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
99
	 */
	private $templateName;

	/**
100
	 * @var string $extensionKey
101
102
103
104
	 */
	private $extensionKey;

	/**
105
	 * @var array $markers
106
	 */
Torsten Oppermann's avatar
Torsten Oppermann committed
107
	private $markers;
108

109
110
111
	/**
	 * @var array $bccAddresses
	 */
Paul Ilea's avatar
Paul Ilea committed
112
	private $bccAddresses;
113

114
115
116
117
118
	/**
	 * @var int
	 */
	private $priority = Mail::PRIORITY_LOWEST;

119
120
121
122
123
	/**
	 * @var int
	 */
	private $pid;

124
125
126
127
128
	/**
	 * @var string
	 */
	private $fromName = '';

129
130
131
	/**
	 * @var \SGalinski\SgMail\Domain\Repository\TemplateRepository
	 */
132
133
134
135
136
137
	protected $templateRepository;

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

139
140
141
142
143
	/**
	 * @var \TYPO3\CMS\Extbase\Object\ObjectManager
	 */
	protected $objectManager;

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

157
158
159
160
161
162
		/** @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
163
		$tsSettings = $typoScriptSettingsService->getSettings(0, 'tx_sgmail');
164
165
166
167
		/** @var TemplateRepository templateRepository */
		$this->templateRepository = $this->objectManager->get(TemplateRepository::class);
		/** @var PersistenceManager persistenceManager */
		$this->persistenceManager = $this->objectManager->get(PersistenceManager::class);
168

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

Torsten Oppermann's avatar
Torsten Oppermann committed
175
			if (!filter_var($tsSettings['mail']['default']['from'], FILTER_VALIDATE_EMAIL)) {
176
177
				$this->fromAddress = 'noreply@example.org';
			} else {
Torsten Oppermann's avatar
Torsten Oppermann committed
178
				$this->fromAddress = $tsSettings['mail']['default']['from'];
179
			}
180
181
		}

182
		$this->mailMessage->setFrom($this->fromAddress);
183

Torsten Oppermann's avatar
Torsten Oppermann committed
184
185
		$this->bccAddresses = GeneralUtility::trimExplode(',', $tsSettings['mail']['default']['bcc']);
		$this->ccAddresses = GeneralUtility::trimExplode(',', $tsSettings['mail']['default']['cc']);
186
187
188
189
190
191
192
193
194
195
196
197
198

		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]);
			}
		}

199
		if (count($this->bccAddresses) > 0) {
200
201
202
			$this->mailMessage->setBcc($this->bccAddresses);
		}

203
		if (count($this->ccAddresses) > 0) {
204
205
			$this->mailMessage->setCc($this->ccAddresses);
		}
206
207
	}

208
209
210
211
212
213
214
215
216
	/**
	 * 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') {
217
		$languagePath = 'LLL:EXT:' . $extensionKey . '/Resources/Private/Language/locallang.xlf:' . $translationKey;
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237

		// 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;
	}

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

257
258
259
		if ($this->pid) {
			$pageUid = $this->pid;
		}
260
		$siteRootId = BackendService::getSiteRoot($pageUid);
261

262
		/** @var Template $template */
263
		$template = $this->templateRepository->findOneByTemplate(
264
			$this->extensionKey, $this->templateName, $this->language, $siteRootId
265
		);
266

267
268
269
270
271
272
		if ($template === NULL) {
			$template = $this->templateRepository->findOneByTemplate(
				$this->extensionKey, $this->templateName, 'default', $siteRootId
			);
		}

273
274
275
276
277
		// if there is a template, prefer those values
		if ($template) {
			$this->loadTemplateValues($template);
		}

Torsten Oppermann's avatar
Torsten Oppermann committed
278
		$defaultTemplateContent = NULL;
279
280
		// If there is no template for this language, use the default template
		if ($template === NULL) {
281

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

284
285
286
287
288
289
			// 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;
290
			}
291
		} elseif (filter_var($template->getToAddress(), FILTER_VALIDATE_EMAIL)) {
292
			$this->setToAddresses($template->getToAddress());
293
294
		}

Torsten Oppermann's avatar
Torsten Oppermann committed
295
296
		if ($isPreview) {
			$previewMarker = [];
Paul Ilea's avatar
Paul Ilea committed
297
			/** @var array $markerArray */
298
			$markerArray = self::getRegisterArray()[$this->extensionKey][$this->templateName]['marker'];
Torsten Oppermann's avatar
Torsten Oppermann committed
299
			foreach ($markerArray as $marker) {
300
301
302
303
304
305
306
307
308
309
310
311
				$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 {
312
						$temporaryMarkerArray = [$markerPathSegment => $temporaryMarkerArray];
313
					}
314
				}
315
				$previewMarker = array_merge_recursive($previewMarker, $temporaryMarkerArray);
Torsten Oppermann's avatar
Torsten Oppermann committed
316
			}
317
			$this->setIgnoreMailQueue(TRUE);
Torsten Oppermann's avatar
Torsten Oppermann committed
318
319
320
			$this->setMarkers($previewMarker);
		}

321
		/** @var StandaloneView $emailView */
322
		$emailView = $this->objectManager->get(StandaloneView::class);
323

324
		if (NULL === $defaultTemplateContent) {
325
			$emailView->setTemplateSource($template->getContent());
326
			$subject = $template->getSubject();
327
328
		} else {
			$emailView->setTemplateSource($defaultTemplateContent);
329

330
			$subject = self::getRegisterArray()[$this->extensionKey][$this->templateName]['subject'];
331
			if (is_array($subject)) {
332
333
				$subject = self::getRegisterArray(
				)[$this->extensionKey][$this->templateName]['subject'][$this->language];
334
335
			} else {
				$subject = LocalizationUtility::translate(
336
					self::getRegisterArray()[$this->extensionKey][$this->templateName]['subject'],
337
338
339
					$this->extensionKey
				);
			}
340
		}
341
		$this->mailMessage->setSubject($subject);
342

343
		$emailView->assignMultiple($this->markers);
344
		$emailBody = $emailView->render();
345

346
347
348
349
		// 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);
		if ($this->ignoreMailQueue) {
350

351
			$this->mailMessage->setBody($emailBody, 'text/html');
352
			$this->mailMessage->send();
353
			$dateTime = new DateTime();
354
			$currentTimestamp = $dateTime->getTimestamp();
355
356
357
358

			if (!$isPreview) {
				$this->addMailToMailQueue(
					$this->extensionKey, $this->templateName, $subject, $emailBody, $this->priority,
359
					$currentTimestamp, $currentTimestamp, $this->language, $siteRootId
360
361
				);
			}
362

363
		} else {
364
365
			if (!$isPreview) {
				$this->addMailToMailQueue(
366
					$this->extensionKey, $this->templateName, $subject, $emailBody, $this->priority, 0, 0,
367
368
369
					$this->language, $siteRootId
				);
			}
370
		}
371
372

		return TRUE;
373
374
375
	}

	/**
376
	 * Adds a new mail to the mail queue.
377
	 *
378
379
	 * @param string $extensionKey
	 * @param string $templateName
380
	 * @param string $subject
381
	 * @param string $emailBody
382
	 * @param int $sendingTime
383
	 * @param int $priority
384
	 * @param int $lastSendingTime
385
	 * @param string $language
386
	 * @param int $pid
Paul Ilea's avatar
Paul Ilea committed
387
	 * @throws \TYPO3\CMS\Extbase\Persistence\Exception\IllegalObjectTypeException
388
	 */
389
	private function addMailToMailQueue(
390
		$extensionKey, $templateName, $subject, $emailBody, $priority, $sendingTime = 0,
391
		$lastSendingTime = 0, $language = self::DEFAULT_LANGUAGE, $pid = 0
392
	) {
393
		$mail = $this->objectManager->get(Mail::class);
394
		$mail->setPid($pid);
395
396
		$mail->setExtensionKey($extensionKey);
		$mail->setTemplateName($templateName);
397
		$mail->setLanguage($language);
398

399
		$mail->setFromAddress($this->fromAddress);
400
		$mail->setFromName($this->fromName);
401

402
		$mail->setToAddress($this->toAddresses);
403
		$mail->setMailSubject($subject);
404
		$mail->setMailBody($emailBody);
405
		$mail->setPriority($priority);
406
407
		$mail->setBccAddresses($this->bccAddresses);
		$mail->setCcAddresses($this->ccAddresses);
408
		$mail->setSendingTime($sendingTime);
409
		$mail->setLastSendingTime($lastSendingTime);
410
		$mail->setReplyTo($this->replyToAddress);
411

412
		$mailRepository = $this->objectManager->get(MailRepository::class);
413
		$mailRepository->add($mail);
414
		$this->persistenceManager->persistAll();
415
	}
416

417
418
419
420
	/**
	 * Send a Mail from the queue, identified by its id
	 *
	 * @param int $uid
Paul Ilea's avatar
Paul Ilea committed
421
422
	 * @throws \TYPO3\CMS\Extbase\Persistence\Exception\IllegalObjectTypeException
	 * @throws \TYPO3\CMS\Extbase\Persistence\Exception\UnknownObjectException
423
424
425
426
	 */
	public function sendMailFromQueue($uid) {
		$mailRepository = $this->objectManager->get(MailRepository::class);
		/** @var Mail $mailToSend */
427
		$mailToSend = $mailRepository->findOneByUid($uid);
428
429
430
431
432
433

		if ($mailToSend) {
			$this->mailMessage->setBody($mailToSend->getMailBody(), 'text/html');
			$this->mailMessage->setTo($mailToSend->getToAddress());
			$this->mailMessage->setFrom($mailToSend->getFromAddress(), $mailToSend->getFromName());
			$this->mailMessage->setSubject($mailToSend->getMailSubject());
434

435
			if ($mailToSend->getBccAddresses()) {
436
437
438
				$this->mailMessage->setBcc(GeneralUtility::trimExplode(',', $mailToSend->getBccAddresses()));
			}

439
			if ($mailToSend->getCcAddresses()) {
440
441
442
443
444
445
446
				$this->mailMessage->setCc(GeneralUtility::trimExplode(',', $mailToSend->getCcAddresses()));
			}

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

447
448
			$dateTime = new DateTime();
			$mailToSend->setLastSendingTime($dateTime->getTimestamp());
449
			$this->mailMessage->send();
450
			$mailRepository->update($mailToSend);
451
452
453
		}
	}

454
	/**
455
	 * @param string $toAddresses
456
457
	 * @return MailTemplateService
	 */
458
459
460
	public function setToAddresses($toAddresses) {
		$this->toAddresses = $toAddresses;
		$this->mailMessage->setTo($toAddresses);
461
462
463
464
		return $this;
	}

	/**
465
	 * @param string $fromAddress
466
	 * @param string $fromName
467
468
	 * @return MailTemplateService
	 */
469
	public function setFromAddress($fromAddress, $fromName = '') {
470
471
472
473
474
		if ($fromAddress) {
			$this->fromAddress = $fromAddress;
			$this->mailMessage->setFrom($fromAddress, $fromName);
		}

475
476
477
478
		return $this;
	}

	/**
479
	 * @param string $ccAddresses
480
481
	 * @return MailTemplateService
	 */
482
	public function setCcAddresses($ccAddresses) {
483
484
		if ($ccAddresses) {
			$this->ccAddresses = $ccAddresses;
485
			$this->mailMessage->setCc(GeneralUtility::trimExplode(',', $this->ccAddresses));
486
487
		}

488
489
490
491
		return $this;
	}

	/**
492
	 * @param string $replyToAddress
493
494
	 * @return MailTemplateService
	 */
495
	public function setReplyToAddress($replyToAddress) {
496
497
498
499
500
		if ($replyToAddress) {
			$this->replyToAddress = $replyToAddress;
			$this->mailMessage->setReplyTo($replyToAddress);
		}

501
502
503
504
505
506
507
508
509
510
511
512
513
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
		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;
	}

540
	/**
541
	 * @param array $markers
542
543
	 * @return MailTemplateService
	 */
544
545
	public function setMarkers(array $markers) {
		$this->markers = $markers;
546
547
		return $this;
	}
548
549

	/**
550
	 * @param string $bccAddresses
551
552
	 * @return MailTemplateService
	 */
553
	public function setBccAddresses($bccAddresses) {
554
555
		if ($bccAddresses) {
			$this->bccAddresses = $bccAddresses;
556
			$this->mailMessage->setBcc(GeneralUtility::trimExplode(',', $this->bccAddresses));
557
558
		}

559
560
561
		return $this;
	}

562
563
564
565
566
567
568
569
	/**
	 * @param int $priority
	 * @return MailTemplateService
	 */
	public function setPriority($priority) {
		$this->priority = $priority;
		return $this;
	}
570
571
572

	/**
	 * @param Swift_OutputByteStream $data
Paul Ilea's avatar
Paul Ilea committed
573
	 * @param string $filename
574
575
576
577
578
579
580
581
582
583
584
	 * @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;
	}
585
586
587
588
589
590
591
592

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

593
594
595
596
597
598
	/**
	 * use all values from the given template
	 *
	 * @param Template $template
	 */
	private function loadTemplateValues($template) {
599
600
601
602
603
604
605
606
607
608
609
610
611
612
		$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);
613
614
615
		$this->setCcAddresses($template->getCc());
		$this->setBccAddresses($template->getBcc());
		$this->setReplyToAddress($template->getReplyTo());
616
		$this->setFromName($fromName);
617
618
619
620
621
622
623
624
		$this->setReplyToAddress($template->getReplyTo());
	}

	/**
	 * @param string $fromName
	 */
	public function setFromName($fromName) {
		$this->fromName = $fromName;
625
	}
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646

	/**
	 * 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');
		}
	}
647
648
649
650
651
652
653
654
655
656
657

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

659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
	/**
	 * 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;
	}

687
688
689
690
691
	/**
	 * Iterate over all installed extensions and look for sg_mail configuration files
	 * If found, register the template(s)
	 *
	 * @throws \BadFunctionCallException
692
	 * @return array
693
694
695
	 */
	public static function registerExtensions() {
		// clear registerArray
696
		$registerArray = [];
697
698
699
700
701
702
703
704
705
706

		$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);
707
708
709
710
711
712
713
714
715
716
717
718
719
				$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;
720

721
722
723
				if ($configArray['template_path']) {
					$templatePath = $configArray['template_key'];
				}
724

725
726
727
728
729
730
731
732
733
734
735
736
737
				$description = $configArray['description'];
				$subject = $configArray['subject'];
				$marker = $configArray['markers'];

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

740
		return $registerArray;
741
	}
742
}