MailTemplateService.php 9.82 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
76
77
78
79
80
81
82
	 */
	private $ignoreMailQueue = TRUE;

	/**
	 * @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
	 * @return void
Torsten Oppermann's avatar
Torsten Oppermann committed
172
	 */
173
	public static function registerTemplate($extension, $templateName, $templatePath, $description, array $markers) {
174
		MailTemplateService::$registerArray[$extension][$templateName] = [
175
			'templatePath' => $templatePath,
176
			'description' => $description,
177
			'marker' => $markers,
178
179
			'extension' => $extension,
			'templateName' => $templateName
180
181
		];
	}
182
183

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

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

205
206
207
208
209
210
211
212
		// 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
213
214
				$this->setLanguage('en');
				$this->sendEmail();
215
			}
216
217
		}

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

227
228
229
230
		$objectManager = GeneralUtility::makeInstance(ObjectManager::class);
		/** @var StandaloneView $emailView */
		$emailView = $objectManager->get(StandaloneView::class);

231
232
		if (!isset($defaultTemplateContent)) {
			$emailView->setTemplateSource($template->getContent());
Torsten Oppermann's avatar
Torsten Oppermann committed
233
			$this->mailMessage->setSubject($template->getSubject());
234
235
		} else {
			$emailView->setTemplateSource($defaultTemplateContent);
236
			$this->mailMessage->setSubject($subject);
237
238
		}

239
		$emailView->assignMultiple($this->markers);
240
		$emailBody = $emailView->render();
241

242
		if ($this->ignoreMailQueue) {
243
244
245
			// 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);
246

247
			$this->mailMessage->setBody($emailBody, 'text/html');
248
			$this->mailMessage->send();
249
		} else {
250
			$this->addMailToMailQueue($emailBody, $this->priority);
251
		}
252
253

		return TRUE;
254
255
256
	}

	/**
257
	 * Adds a new mail to the mail queue.
258
	 *
259
	 * @param string $emailBody
260
261
	 * @param int $priority
	 * @param int $pid
262
	 */
263
	private function addMailToMailQueue($emailBody, $priority, $pid = 0) {
264
265
266
267
268
269
270
271
272
		/** @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);
273
274
		$mail->setFromAddress($this->fromAddress);
		$mail->setToAddress($this->toAddresses);
275
276
		$mail->setMailSubject($this->subject);
		$mail->setMailBody($emailBody);
277
		$mail->setPriority($priority);
278
279
		$mail->setBccAddresses(implode(',', $this->bccAddresses));
		$mail->setCcAddresses(implode(',', $this->ccAddresses));
280
281
282

		$mailRepository = $objectManager->get(MailRepository::class);
		$mailRepository->add($mail);
283
	}
284
285
286

	/**
	 * @param array $registerArray
287
	 * @return void
288
	 */
289
	public static function setRegisterArray(array $registerArray) {
290
291
292
293
		self::$registerArray = $registerArray;
	}

	/**
294
	 * @param array|string $toAddresses
295
296
	 * @return MailTemplateService
	 */
297
298
299
	public function setToAddresses($toAddresses) {
		$this->toAddresses = $toAddresses;
		$this->mailMessage->setTo($toAddresses);
300
301
302
303
		return $this;
	}

	/**
304
	 * @param array|string $fromAddress
305
306
	 * @return MailTemplateService
	 */
307
	public function setFromAddress($fromAddress) {
308
309
		$this->fromAddress = $fromAddress;
		$this->mailMessage->setFrom($fromAddress);
310
311
312
313
		return $this;
	}

	/**
314
	 * @param array|string $ccAddresses
315
316
	 * @return MailTemplateService
	 */
317
	public function setCcAddresses($ccAddresses) {
318
319
		$this->ccAddresses[] = $ccAddresses;
		$this->mailMessage->setCc($this->ccAddresses);
320
321
322
323
		return $this;
	}

	/**
324
	 * @param array|string $replyToAddress
325
326
	 * @return MailTemplateService
	 */
327
	public function setReplyToAddress($replyToAddress) {
328
		$this->replyToAddress = $replyToAddress;
329
		$this->mailMessage->setReplyTo($replyToAddress);
330
331
332
333
334
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
		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;
	}

369
	/**
370
	 * @param array $markers
371
372
	 * @return MailTemplateService
	 */
373
374
	public function setMarkers(array $markers) {
		$this->markers = $markers;
375
376
		return $this;
	}
377
378
379
380
381
382

	/**
	 * @param array $bccAddresses
	 * @return MailTemplateService
	 */
	public function setBccAddresses(array $bccAddresses) {
383
384
		$this->bccAddresses[] = $bccAddresses;
		$this->mailMessage->setBcc($this->bccAddresses);
385
386
387
		return $this;
	}

388
389
390
391
392
393
394
395
	/**
	 * @param int $priority
	 * @return MailTemplateService
	 */
	public function setPriority($priority) {
		$this->priority = $priority;
		return $this;
	}
396
}