MailTemplateService.php 9.95 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
30
31
32
33
34
35
36
use SGalinski\SgMail\Domain\Model\Mail;
use SGalinski\SgMail\Domain\Model\Template;
use SGalinski\SgMail\Domain\Repository\MailRepository;
use TYPO3\CMS\Core\Mail\MailMessage;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Extbase\Object\ObjectManager;
use TYPO3\CMS\Fluid\View\StandaloneView;

37
38
39
/**
 * MailTemplateService
 */
40
class MailTemplateService {
41

42
	/**
43
	 * @var array $registerArray
44
	 */
45
	private static $registerArray = [];
46

47
	/**
48
	 * @var array $toAddresses
49
	 */
50
	private $toAddresses = [];
51
52

	/**
53
	 * @var string $fromAddress
54
	 */
55
	private $fromAddress;
56
57

	/**
58
	 * @var array $ccAddresses
59
	 */
60
	private $ccAddresses = [];
61
62

	/**
63
	 * @var string $replyToAddress
64
	 */
65
	private $replyToAddress;
66
67

	/**
68
	 * @var string $language
69
	 */
70
	private $language;
71
72

	/**
73
	 * @var boolean $ignoreMailQueue
74
	 */
75
	private $ignoreMailQueue = FALSE;
76
77
78
79
80
81
82

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

	/**
83
	 * @var string $templateName
84
85
86
87
	 */
	private $templateName;

	/**
88
	 * @var string $extensionKey
89
90
91
92
	 */
	private $extensionKey;

	/**
93
	 * @var array $markers
94
	 */
95
	private $markers = [];
96
97

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

102
103
104
	/**
	 * holds the TypoScript configuration for sg_mail
	 *
105
	 * @var array $tsSettings
106
107
108
	 */
	private $tsSettings = [];

109
110
111
112
113
	/**
	 * @var array $bccAddresses
	 */
	private $bccAddresses = [];

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

119
120
121
122
123
124
	/**
	 * @var \SGalinski\SgMail\Domain\Repository\TemplateRepository
	 * @inject
	 */
	protected $templateRepository = NULL;

125
126
127
128
129
130
	/**
	 * MailTemplateService constructor.
	 */
	public function __construct() {
		$objectManager = GeneralUtility::makeInstance(ObjectManager::class);
		$this->mailMessage = $objectManager->get(MailMessage::class);
131
132
133
134

		$typoScriptSettingsService = $objectManager->get(TypoScriptSettingsService::class);
		$this->tsSettings = $typoScriptSettingsService->getSettings(0, 'tx_sgmail');
		$this->language = $this->tsSettings['templateDefaultLanguage'];
135
136
137
138

		$this->fromAddress = $this->tsSettings['mail']['default']['from'];
		$this->mailMessage->setFrom($this->fromAddress);

139
		$this->bccAddresses = GeneralUtility::trimExplode(',', $this->tsSettings['mail']['default']['bcc']);
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
		$this->ccAddresses = GeneralUtility::trimExplode(',', $this->tsSettings['mail']['default']['cc']);

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

		if (sizeof($this->bccAddresses) > 0) {
			$this->mailMessage->setBcc($this->bccAddresses);
		}

		if (sizeof($this->ccAddresses) > 0) {
			$this->mailMessage->setCc($this->ccAddresses);
		}
161
162
	}

Torsten Oppermann's avatar
Torsten Oppermann committed
163
	/**
Torsten Oppermann's avatar
Torsten Oppermann committed
164
	 * register a template with sg_mail
Fabian Galinski's avatar
Fabian Galinski committed
165
	 *
166
	 * @param string $extension
Torsten Oppermann's avatar
Torsten Oppermann committed
167
168
169
	 * @param string $templateName
	 * @param string $templatePath
	 * @param string $description
170
	 * @param array $markers
171
	 * @param array $subjects
Torsten Oppermann's avatar
Torsten Oppermann committed
172
	 */
173
174
175
	public static function registerTemplate(
		$extension, $templateName, $templatePath, $description, array $markers, array $subjects
	) {
176
		MailTemplateService::$registerArray[$extension][$templateName] = [
177
			'templatePath' => $templatePath,
178
			'description' => $description,
179
			'marker' => $markers,
180
			'extension' => $extension,
181
182
			'templateName' => $templateName,
			'subjects' => $subjects
183
184
		];
	}
185
186

	/**
Torsten Oppermann's avatar
Torsten Oppermann committed
187
	 * Get all registered templates
Fabian Galinski's avatar
Fabian Galinski committed
188
	 *
189
	 * @return array
190
	 */
191
192
	public static function getRegisterArray() {
		return self::$registerArray;
193
	}
194
195

	/**
196
	 * Send the Email
197
	 *
Torsten Oppermann's avatar
Torsten Oppermann committed
198
	 * @param boolean $isPreview
199
	 * @return boolean email was sent or added to mail queue successfully?
200
	 */
201
	public function sendEmail($isPreview = FALSE) {
202
		/** @var Template $template */
203
		$template = $this->templateRepository->findOneByTemplate(
204
			$this->extensionKey, $this->templateName, $this->language
205
		);
206

207
208
209
210
211
212
213
214
		// If there is no template for this language, use the default template
		if ($template === NULL) {
			$templatePath = self::$registerArray[$this->extensionKey][$this->templateName]['templatePath'];
			$templateFile = $templatePath . $this->language . '.template.html';
			if (file_exists($templateFile)) {
				$defaultTemplateContent = file_get_contents($templatePath . $this->language . '.template.html');
			} else {
				// no language found and no default template
Torsten Oppermann's avatar
Torsten Oppermann committed
215
216
				$this->setLanguage('en');
				$this->sendEmail();
217
			}
218
219
		}

Torsten Oppermann's avatar
Torsten Oppermann committed
220
221
222
223
224
225
		if ($isPreview) {
			$previewMarker = [];
			$markerArray = self::$registerArray[$this->extensionKey][$this->templateName]['marker'];
			foreach ($markerArray as $marker) {
				$previewMarker[$marker['marker']] = $marker['value'];
			}
226
			$this->setIgnoreMailQueue(TRUE);
Torsten Oppermann's avatar
Torsten Oppermann committed
227
228
229
			$this->setMarkers($previewMarker);
		}

230
231
232
233
		$objectManager = GeneralUtility::makeInstance(ObjectManager::class);
		/** @var StandaloneView $emailView */
		$emailView = $objectManager->get(StandaloneView::class);

234
235
		if (!isset($defaultTemplateContent)) {
			$emailView->setTemplateSource($template->getContent());
Torsten Oppermann's avatar
Torsten Oppermann committed
236
			$this->mailMessage->setSubject($template->getSubject());
237
238
		} else {
			$emailView->setTemplateSource($defaultTemplateContent);
239
240
241
			$this->mailMessage->setSubject(
				self::$registerArray[$this->extensionKey][$this->templateName]['subjects'][$this->language]
			);
242
243
		}

244
		$emailView->assignMultiple($this->markers);
245
		$emailBody = $emailView->render();
246

247
		if ($this->ignoreMailQueue) {
248
249
250
			// 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);
251

252
			$this->mailMessage->setBody($emailBody, 'text/html');
253
			$this->mailMessage->send();
254
		} else {
255
			$this->addMailToMailQueue($emailBody, $this->priority);
256
		}
257
258

		return TRUE;
259
260
261
	}

	/**
262
	 * Adds a new mail to the mail queue.
263
	 *
264
	 * @param string $emailBody
265
266
	 * @param int $priority
	 * @param int $pid
267
	 */
268
	private function addMailToMailQueue($emailBody, $priority, $pid = 0) {
269
270
271
272
273
274
275
276
277
		/** @var ObjectManager $objectManager */
		$objectManager = GeneralUtility::makeInstance(ObjectManager::class);

		if ($pid <= 0 && isset($GLOBALS['TSFE'])) {
			$pid = (int) $GLOBALS['TSFE']->id;
		}

		$mail = $objectManager->get(Mail::class);
		$mail->setPid($pid);
278
279
		$mail->setFromAddress($this->fromAddress);
		$mail->setToAddress($this->toAddresses);
280
281
		$mail->setMailSubject($this->subject);
		$mail->setMailBody($emailBody);
282
		$mail->setPriority($priority);
283
284
		$mail->setBccAddresses(implode(',', $this->bccAddresses));
		$mail->setCcAddresses(implode(',', $this->ccAddresses));
285
286
287

		$mailRepository = $objectManager->get(MailRepository::class);
		$mailRepository->add($mail);
288
	}
289
290
291

	/**
	 * @param array $registerArray
292
	 * @return void
293
	 */
294
	public static function setRegisterArray(array $registerArray) {
295
296
297
298
		self::$registerArray = $registerArray;
	}

	/**
299
	 * @param array|string $toAddresses
300
301
	 * @return MailTemplateService
	 */
302
303
304
	public function setToAddresses($toAddresses) {
		$this->toAddresses = $toAddresses;
		$this->mailMessage->setTo($toAddresses);
305
306
307
308
		return $this;
	}

	/**
309
	 * @param array|string $fromAddress
310
311
	 * @return MailTemplateService
	 */
312
	public function setFromAddress($fromAddress) {
313
314
		$this->fromAddress = $fromAddress;
		$this->mailMessage->setFrom($fromAddress);
315
316
317
318
		return $this;
	}

	/**
319
	 * @param array|string $ccAddresses
320
321
	 * @return MailTemplateService
	 */
322
	public function setCcAddresses($ccAddresses) {
323
324
		$this->ccAddresses[] = $ccAddresses;
		$this->mailMessage->setCc($this->ccAddresses);
325
326
327
328
		return $this;
	}

	/**
329
	 * @param array|string $replyToAddress
330
331
	 * @return MailTemplateService
	 */
332
	public function setReplyToAddress($replyToAddress) {
333
		$this->replyToAddress = $replyToAddress;
334
		$this->mailMessage->setReplyTo($replyToAddress);
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
		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;
	}

374
	/**
375
	 * @param array $markers
376
377
	 * @return MailTemplateService
	 */
378
379
	public function setMarkers(array $markers) {
		$this->markers = $markers;
380
381
		return $this;
	}
382
383
384
385
386
387

	/**
	 * @param array $bccAddresses
	 * @return MailTemplateService
	 */
	public function setBccAddresses(array $bccAddresses) {
388
389
		$this->bccAddresses[] = $bccAddresses;
		$this->mailMessage->setBcc($this->bccAddresses);
390
391
392
		return $this;
	}

393
394
395
396
397
398
399
400
	/**
	 * @param int $priority
	 * @return MailTemplateService
	 */
	public function setPriority($priority) {
		$this->priority = $priority;
		return $this;
	}
401
}