Skip to content

EspoCRM – Open Source CRM Application

Email template cleanup

Yurii64731f56a04d
diff --git a/application/Espo/Tools/EmailTemplate/Processor.php b/application/Espo/Tools/EmailTemplate/Processor.php
index 1d854dd480..8dc976a6e1 100644
--- a/application/Espo/Tools/EmailTemplate/Processor.php
+++ b/application/Espo/Tools/EmailTemplate/Processor.php
@@ -55,6 +55,14 @@ class Processor
{
private const string KEY_PARENT = 'Parent';
+ /** @var string[] */
+ private array $stripPlaceholderList = [
+ '{Person.firstName}',
+ '{Person.lastName}',
+ '{Person.name}',
+ '{Person.salutationName}',
+ ];
+
public function __construct(
private Formatter $formatter,
private EntityManager $entityManager,
@@ -121,6 +129,9 @@ class Processor
$subject = $this->processPlaceholders($subject, $data);
$body = $this->processPlaceholders($body, $data);
+ $subject = $this->processCleanup($subject);
+ $body = $this->processCleanup($body);
+
$attachmentList = $params->copyAttachments() ?
$this->copyAttachments($template) : [];
@@ -452,4 +463,15 @@ class Processor
return [$entityHash, $data];
}
+
+ private function processCleanup(string $text): string
+ {
+ $pairs = [];
+
+ foreach ($this->stripPlaceholderList as $item) {
+ $pairs[$item] = '';
+ }
+
+ return strtr($text, $pairs);
+ }
}
diff --git a/tests/integration/Espo/Tools/EmailTemplate/ProcessorTest.php b/tests/integration/Espo/Tools/EmailTemplate/ProcessorTest.php
index 7b4d7d2b5f..a90bd9cd9b 100644
--- a/tests/integration/Espo/Tools/EmailTemplate/ProcessorTest.php
+++ b/tests/integration/Espo/Tools/EmailTemplate/ProcessorTest.php
@@ -34,6 +34,7 @@ use Espo\Core\Field\LinkMultiple;
use Espo\Entities\EmailTemplate;
use Espo\Entities\Team;
use Espo\Entities\User;
+use Espo\Modules\Crm\Entities\Account;
use Espo\Modules\Crm\Entities\Lead;
use Espo\Tools\EmailTemplate\Data as TemplateData;
use Espo\Tools\EmailTemplate\Params as TemplateParams;
@@ -42,7 +43,7 @@ use tests\integration\Core\BaseTestCase;
class ProcessorTest extends BaseTestCase
{
- public function testProcess(): void
+ public function testProcessAccess(): void
{
$em = $this->getEntityManager();
@@ -79,7 +80,14 @@ class ProcessorTest extends BaseTestCase
'subject' => '{{name}} {{password}} {{defaultTeam.name}}',
'body' => '{User.name} {User.password} {User.defaultTeam.name}',
]);
- $em->saveEntity($template2);
+ $em->saveEntity($template3);
+
+ $template4 = $em->getRDBRepositoryByClass(EmailTemplate::class)->getNew();
+ $template4->setMultiple([
+ 'subject' => '{{name}} {{password}} {{defaultTeam.name}}',
+ 'body' => '{User.name} {User.password} {User.defaultTeam.name}',
+ ]);
+ $em->saveEntity($template4);
$lead = $em->getRDBRepositoryByClass(Lead::class)->getNew();
$lead
@@ -137,4 +145,62 @@ class ProcessorTest extends BaseTestCase
$emailData3->getBody(),
);
}
+
+ public function testProcessAndCleanup(): void
+ {
+ $em = $this->getEntityManager();
+
+ $account = $em->getRDBRepositoryByClass(Account::class)->getNew();
+ $account->setName('Account 1');
+ $em->saveEntity($account);
+
+ $lead = $em->getRDBRepositoryByClass(Lead::class)->getNew();
+ $lead->setFirstName('One');
+ $em->saveEntity($lead);
+ $em->refreshEntity($lead);
+
+ $template1 = $em->getRDBRepositoryByClass(EmailTemplate::class)->getNew();
+ $template1->setMultiple([
+ 'subject' => 'Test {Person.firstName} test {Account.name}',
+ 'body' => 'Test {Person.name} test {Account.name}.',
+ ]);
+ $em->saveEntity($template1);
+
+ //
+
+ $processor = $this->getInjectableFactory()->create(Processor::class);
+
+ $params = TemplateParams::create()
+ ->withApplyAcl(false);
+
+ $data = TemplateData::create();
+
+ //
+
+ $emailData1 = $processor->process($template1, $params, $data->withParent($account));
+
+ $this->assertEquals(
+ 'Test test Account 1',
+ $emailData1->getSubject(),
+ );
+
+ $this->assertEquals(
+ 'Test test Account 1.',
+ $emailData1->getBody(),
+ );
+
+ //
+
+ $emailData2 = $processor->process($template1, $params, $data->withParent($lead));
+
+ $this->assertEquals(
+ 'Test One test {Account.name}',
+ $emailData2->getSubject(),
+ );
+
+ $this->assertEquals(
+ 'Test One test {Account.name}.',
+ $emailData2->getBody(),
+ );
+ }
}