MailTemplateService.php 9.22 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
		// If there is no template for this language, use the english template
		if ($template === NULL && $this->language !== 'en') {
			$this->setLanguage('en');
			$this->sendEmail();
		}

215
216
217
218
		if ($template === NULL) {
			return FALSE;
		}

219
		$emailView->setTemplateSource($template->getContent());
220
		$emailView->assignMultiple($this->markers);
221
		$emailBody = $emailView->render();
222

223
		if ($this->ignoreMailQueue) {
224
225
226
			// 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);
227

228
			$this->mailMessage->setSubject($template->getSubject());
229
			$this->mailMessage->setBody($emailBody, 'text/html');
230
			$this->mailMessage->send();
231
		} else {
232
			$this->addMailToMailQueue($emailBody, $this->priority);
233
		}
234
235

		return TRUE;
236
237
238
	}

	/**
239
	 * Adds a new mail to the mail queue.
240
	 *
241
	 * @param string $emailBody
242
243
	 * @param int $priority
	 * @param int $pid
244
	 */
245
	private function addMailToMailQueue($emailBody, $priority, $pid = 0) {
246
247
248
249
250
251
252
253
254
		/** @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);
255
256
		$mail->setFromAddress($this->fromAddress);
		$mail->setToAddress($this->toAddresses);
257
258
		$mail->setMailSubject($this->subject);
		$mail->setMailBody($emailBody);
259
		$mail->setPriority($priority);
260
261
		$mail->setBccAddresses(implode(',', $this->bccAddresses));
		$mail->setCcAddresses(implode(',', $this->ccAddresses));
262
263
264

		$mailRepository = $objectManager->get(MailRepository::class);
		$mailRepository->add($mail);
265
	}
266
267
268
269
270

	/**
	 * @param array $registerArray
	 * @return MailTemplateService
	 */
271
	public static function setRegisterArray(array $registerArray) {
272
273
274
275
		self::$registerArray = $registerArray;
	}

	/**
276
	 * @param array|string $toAddresses
277
278
	 * @return MailTemplateService
	 */
279
280
281
	public function setToAddresses($toAddresses) {
		$this->toAddresses = $toAddresses;
		$this->mailMessage->setTo($toAddresses);
282
283
284
285
		return $this;
	}

	/**
286
	 * @param array|string $fromAddress
287
288
	 * @return MailTemplateService
	 */
289
	public function setFromAddress($fromAddress) {
290
291
		$this->fromAddress = $fromAddress;
		$this->mailMessage->setFrom($fromAddress);
292
293
294
295
		return $this;
	}

	/**
296
	 * @param array|string $ccAddresses
297
298
	 * @return MailTemplateService
	 */
299
	public function setCcAddresses($ccAddresses) {
300
301
		$this->ccAddresses[] = $ccAddresses;
		$this->mailMessage->setCc($this->ccAddresses);
302
303
304
305
		return $this;
	}

	/**
306
	 * @param array|string $replyToAddress
307
308
	 * @return MailTemplateService
	 */
309
	public function setReplyToAddress($replyToAddress) {
310
		$this->replyToAddress = $replyToAddress;
311
		$this->mailMessage->setReplyTo($replyToAddress);
312
313
314
315
316
317
318
319
320
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
		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;
	}
360
361

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

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

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

389
}