MailTemplateService.php 8.92 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\Exception;
9
use TYPO3\CMS\Core\Mail\MailMessage;
10
use TYPO3\CMS\Core\Utility\GeneralUtility;
Torsten Oppermann's avatar
Torsten Oppermann committed
11
use TYPO3\CMS\Extbase\Object\ObjectManager;
12
use TYPO3\CMS\Fluid\View\StandaloneView;
13

14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
/***************************************************************
 *  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!
 ***************************************************************/
37
38
39
40

/**
 * MailTemplateService
 */
41
class MailTemplateService {
42

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

135
		$this->bccAddresses = GeneralUtility::trimExplode(',', $this->tsSettings['mail']['default']['bcc']);
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
		$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);
		}
157
158
	}

Torsten Oppermann's avatar
Torsten Oppermann committed
159
	/**
Torsten Oppermann's avatar
Torsten Oppermann committed
160
	 * register a template with sg_mail
Fabian Galinski's avatar
Fabian Galinski committed
161
	 *
162
	 * @param string $extension
Torsten Oppermann's avatar
Torsten Oppermann committed
163
164
165
	 * @param string $templateName
	 * @param string $templatePath
	 * @param string $description
166
	 * @param array $markers
167
	 * @return string
Torsten Oppermann's avatar
Torsten Oppermann committed
168
	 */
169
	public static function registerTemplate($extension, $templateName, $templatePath, $description, array $markers) {
170

171
		MailTemplateService::$registerArray[$extension][$templateName] = [
172
			'templatePath' => $templatePath,
173
			'description' => $description,
174
			'marker' => $markers,
175
176
			'extension' => $extension,
			'templateName' => $templateName
177
178
		];
	}
179
180

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

	/**
190
	 * Send the Email
191
192
	 *
	 * @return boolean email was sent or added to mail queue successfully?
193
	 */
194
	public function sendEmail() {
195

196
		$objectManager = GeneralUtility::makeInstance(ObjectManager::class);
197
		/** @var StandaloneView $emailView */
Torsten Oppermann's avatar
Torsten Oppermann committed
198
		$emailView = $objectManager->get(StandaloneView::class);
199
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
		// If there is no template for this language, use the english template
		if ($template === NULL && $this->language !== 'en') {
			$this->setLanguage('en');
			$this->sendEmail();
		}

211
212
213
214
		if ($template === NULL) {
			return FALSE;
		}

215
		$emailView->setTemplateSource($template->getContent());
216
		$emailView->assignMultiple($this->markers);
217
		$emailBody = $emailView->render();
218

219
		if ($this->ignoreMailQueue) {
220
221
222
			// 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);
223

224
			$this->mailMessage->setSubject($template->getSubject());
225
			$this->mailMessage->setBody($emailBody, 'text/html');
226
			$this->mailMessage->send();
227
		} else {
228
			$this->addMailToMailQueue($emailBody);
229
		}
230
231

		return TRUE;
232
233
234
	}

	/**
235
	 * Adds a new mail to the mail queue.
236
	 *
237
	 * @param string $emailBody
238
239
	 * @param int $priority
	 * @param int $pid
240
241
	 */
	private function addMailToMailQueue($emailBody, $priority = Mail::PRIORITY_LOWEST, $pid = 0) {
242
243
244
245
246
247
248
249
250
		/** @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);
251
252
		$mail->setFromAddress($this->fromAddress);
		$mail->setToAddress($this->toAddresses);
253
254
		$mail->setMailSubject($this->subject);
		$mail->setMailBody($emailBody);
255
256
257
258
		$mail->setPriority($priority);

		$mailRepository = $objectManager->get(MailRepository::class);
		$mailRepository->add($mail);
259
	}
260
261
262
263
264

	/**
	 * @param array $registerArray
	 * @return MailTemplateService
	 */
265
	public static function setRegisterArray(array $registerArray) {
266
267
268
269
		self::$registerArray = $registerArray;
	}

	/**
270
	 * @param array|string $toAddresses
271
272
	 * @return MailTemplateService
	 */
273
274
275
	public function setToAddresses($toAddresses) {
		$this->toAddresses = $toAddresses;
		$this->mailMessage->setTo($toAddresses);
276
277
278
279
		return $this;
	}

	/**
280
	 * @param array|string $fromAddress
281
282
	 * @return MailTemplateService
	 */
283
	public function setFromAddress($fromAddress) {
284
285
		$this->fromAddress = $fromAddress;
		$this->mailMessage->setFrom($fromAddress);
286
287
288
289
		return $this;
	}

	/**
290
	 * @param array|string $ccAddresses
291
292
	 * @return MailTemplateService
	 */
293
	public function setCcAddresses($ccAddresses) {
294
295
		$this->ccAddresses[] = $ccAddresses;
		$this->mailMessage->setCc($this->ccAddresses);
296
297
298
299
		return $this;
	}

	/**
300
	 * @param array|string $replyToAddress
301
302
	 * @return MailTemplateService
	 */
303
	public function setReplyToAddress($replyToAddress) {
304
		$this->replyToAddress = $replyToAddress;
305
		$this->mailMessage->setReplyTo($replyToAddress);
306
307
308
309
310
311
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
		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;
	}
354
355

	/**
356
	 * @param array $markers
357
358
	 * @return MailTemplateService
	 */
359
360
	public function setMarkers(array $markers) {
		$this->markers = $markers;
361
362
		return $this;
	}
363
364
365
366
367
368

	/**
	 * @param array $bccAddresses
	 * @return MailTemplateService
	 */
	public function setBccAddresses(array $bccAddresses) {
369
370
		$this->bccAddresses[] = $bccAddresses;
		$this->mailMessage->setBcc($this->bccAddresses);
371
372
373
		return $this;
	}

374
}