MailTemplateService.php 9.8 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
99
	/**
	 * holds the TypoScript configuration for sg_mail
	 *
100
	 * @var array $tsSettings
101
102
103
	 */
	private $tsSettings = [];

104
105
106
107
108
	/**
	 * @var array $bccAddresses
	 */
	private $bccAddresses = [];

109
110
111
112
113
	/**
	 * @var int
	 */
	private $priority = Mail::PRIORITY_LOWEST;

114
115
116
117
118
119
	/**
	 * @var \SGalinski\SgMail\Domain\Repository\TemplateRepository
	 * @inject
	 */
	protected $templateRepository = NULL;

120
121
122
123
124
125
	/**
	 * MailTemplateService constructor.
	 */
	public function __construct() {
		$objectManager = GeneralUtility::makeInstance(ObjectManager::class);
		$this->mailMessage = $objectManager->get(MailMessage::class);
126
127
128
129

		$typoScriptSettingsService = $objectManager->get(TypoScriptSettingsService::class);
		$this->tsSettings = $typoScriptSettingsService->getSettings(0, 'tx_sgmail');
		$this->language = $this->tsSettings['templateDefaultLanguage'];
130
131
132
133

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

134
		$this->bccAddresses = GeneralUtility::trimExplode(',', $this->tsSettings['mail']['default']['bcc']);
135
136
137
138
139
140
141
142
143
144
145
146
147
148
		$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]);
			}
		}

149
		if (count($this->bccAddresses) > 0) {
150
151
152
			$this->mailMessage->setBcc($this->bccAddresses);
		}

153
		if (count($this->ccAddresses) > 0) {
154
155
			$this->mailMessage->setCc($this->ccAddresses);
		}
156
157
	}

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

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

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

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

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

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

230
231
		if (!isset($defaultTemplateContent)) {
			$emailView->setTemplateSource($template->getContent());
232
			$subject = $template->getSubject();
233
234
		} else {
			$emailView->setTemplateSource($defaultTemplateContent);
235
			$subject = self::$registerArray[$this->extensionKey][$this->templateName]['subjects'][$this->language];
236
		}
237
		$this->mailMessage->setSubject($subject);
238

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

242
243
244
		// 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);
245

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

		return TRUE;
254
255
256
	}

	/**
257
	 * Adds a new mail to the mail queue.
258
	 *
259
	 * @param string $subject
260
	 * @param string $emailBody
261
	 * @param int $priority
262
	 */
263
	private function addMailToMailQueue($subject, $emailBody, $priority) {
264
265
266
267
		/** @var ObjectManager $objectManager */
		$objectManager = GeneralUtility::makeInstance(ObjectManager::class);

		$mail = $objectManager->get(Mail::class);
268
269
		$mail->setFromAddress($this->fromAddress);
		$mail->setToAddress($this->toAddresses);
270
		$mail->setMailSubject($subject);
271
		$mail->setMailBody($emailBody);
272
		$mail->setPriority($priority);
273
274
		$mail->setBccAddresses(implode(',', $this->bccAddresses));
		$mail->setCcAddresses(implode(',', $this->ccAddresses));
275
276
277

		$mailRepository = $objectManager->get(MailRepository::class);
		$mailRepository->add($mail);
278
	}
279
280
281

	/**
	 * @param array $registerArray
282
	 * @return void
283
	 */
284
	public static function setRegisterArray(array $registerArray) {
285
286
287
288
		self::$registerArray = $registerArray;
	}

	/**
289
	 * @param array|string $toAddresses
290
291
	 * @return MailTemplateService
	 */
292
293
294
	public function setToAddresses($toAddresses) {
		$this->toAddresses = $toAddresses;
		$this->mailMessage->setTo($toAddresses);
295
296
297
298
		return $this;
	}

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

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

	/**
319
	 * @param array|string $replyToAddress
320
321
	 * @return MailTemplateService
	 */
322
	public function setReplyToAddress($replyToAddress) {
323
		$this->replyToAddress = $replyToAddress;
324
		$this->mailMessage->setReplyTo($replyToAddress);
325
326
327
328
329
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
		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;
	}

364
	/**
365
	 * @param array $markers
366
367
	 * @return MailTemplateService
	 */
368
369
	public function setMarkers(array $markers) {
		$this->markers = $markers;
370
371
		return $this;
	}
372
373
374
375
376
377

	/**
	 * @param array $bccAddresses
	 * @return MailTemplateService
	 */
	public function setBccAddresses(array $bccAddresses) {
378
379
		$this->bccAddresses[] = $bccAddresses;
		$this->mailMessage->setBcc($this->bccAddresses);
380
381
382
		return $this;
	}

383
384
385
386
387
388
389
390
	/**
	 * @param int $priority
	 * @return MailTemplateService
	 */
	public function setPriority($priority) {
		$this->priority = $priority;
		return $this;
	}
391
}