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

namespace SGalinski\SgMail\Service;

5
use SGalinski\SgMail\Domain\Model\Mail;
6
use SGalinski\SgMail\Domain\Model\Template;
7
use SGalinski\SgMail\Domain\Repository\MailRepository;
8
use TYPO3\CMS\Core\Mail\MailMessage;
9
use TYPO3\CMS\Core\Utility\GeneralUtility;
Torsten Oppermann's avatar
Torsten Oppermann committed
10
use TYPO3\CMS\Extbase\Object\ObjectManager;
11
use TYPO3\CMS\Fluid\View\StandaloneView;
12

13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
/***************************************************************
 *  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!
 ***************************************************************/
36
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 string
Torsten Oppermann's avatar
Torsten Oppermann committed
172
	 */
173
	public static function registerTemplate($extension, $templateName, $templatePath, $description, array $markers) {
174

175
		MailTemplateService::$registerArray[$extension][$templateName] = [
176
			'templatePath' => $templatePath,
177
			'description' => $description,
178
			'marker' => $markers,
179
180
			'extension' => $extension,
			'templateName' => $templateName
181
182
		];
	}
183
184

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

	/**
194
	 * Send the Email
195
196
	 *
	 * @return boolean email was sent or added to mail queue successfully?
197
	 */
198
	public function sendEmail() {
199

200
		$objectManager = GeneralUtility::makeInstance(ObjectManager::class);
201
		/** @var StandaloneView $emailView */
Torsten Oppermann's avatar
Torsten Oppermann committed
202
		$emailView = $objectManager->get(StandaloneView::class);
203
204
205
206
207

		/** @var Template $template */
		$template = $this->templateRepository->findTemplate(
			$this->extensionKey, $this->templateName, $this->language
		)->getFirst();
208

209
210
211
212
213
214
215
216
		// 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
217
218
				$this->setLanguage('en');
				$this->sendEmail();
219
			}
220
221
		}

222
223
		if (!isset($defaultTemplateContent)) {
			$emailView->setTemplateSource($template->getContent());
Torsten Oppermann's avatar
Torsten Oppermann committed
224
			$this->mailMessage->setSubject($template->getSubject());
225
226
		} else {
			$emailView->setTemplateSource($defaultTemplateContent);
Torsten Oppermann's avatar
Torsten Oppermann committed
227
			$this->mailMessage->setSubject('');
228
229
		}

230
		$emailView->assignMultiple($this->markers);
231
		$emailBody = $emailView->render();
232

233
		if ($this->ignoreMailQueue) {
234
235
236
			// 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);
237

238
			$this->mailMessage->setBody($emailBody, 'text/html');
239
			$this->mailMessage->send();
240
		} else {
241
			$this->addMailToMailQueue($emailBody, $this->priority);
242
		}
243
244

		return TRUE;
245
246
247
	}

	/**
248
	 * Adds a new mail to the mail queue.
249
	 *
250
	 * @param string $emailBody
251
252
	 * @param int $priority
	 * @param int $pid
253
	 */
254
	private function addMailToMailQueue($emailBody, $priority, $pid = 0) {
255
256
257
258
259
260
261
262
263
		/** @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);
264
265
		$mail->setFromAddress($this->fromAddress);
		$mail->setToAddress($this->toAddresses);
266
267
		$mail->setMailSubject($this->subject);
		$mail->setMailBody($emailBody);
268
		$mail->setPriority($priority);
269
270
		$mail->setBccAddresses(implode(',', $this->bccAddresses));
		$mail->setCcAddresses(implode(',', $this->ccAddresses));
271
272
273

		$mailRepository = $objectManager->get(MailRepository::class);
		$mailRepository->add($mail);
274
	}
275
276
277
278
279

	/**
	 * @param array $registerArray
	 * @return MailTemplateService
	 */
280
	public static function setRegisterArray(array $registerArray) {
281
282
283
284
		self::$registerArray = $registerArray;
	}

	/**
285
	 * @param array|string $toAddresses
286
287
	 * @return MailTemplateService
	 */
288
289
290
	public function setToAddresses($toAddresses) {
		$this->toAddresses = $toAddresses;
		$this->mailMessage->setTo($toAddresses);
291
292
293
294
		return $this;
	}

	/**
295
	 * @param array|string $fromAddress
296
297
	 * @return MailTemplateService
	 */
298
	public function setFromAddress($fromAddress) {
299
300
		$this->fromAddress = $fromAddress;
		$this->mailMessage->setFrom($fromAddress);
301
302
303
304
		return $this;
	}

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

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

	/**
	 * @param string $subject
	 * @return MailTemplateService
	 */
	public function setSubject($subject) {
		$this->subject = $subject;
		$this->mailMessage->setSubject($subject);
		return $this;
	}
369
370

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

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

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

398
}