MailProcessor adds Recipient twice

[solverat]

Q	A
Bug report?	yes
Feature request?	no
BC Break report?	no
RFC?	no

• Create a Mail Template
• Add "[email protected]" in To: field
• Use notification rule or just use $this->mailProcessor->sendMail($mailDocument, $order, null, [], $mailParams);
• Mail gets submitted twice

Reason:

CoreShop/src/CoreShop/Component/Pimcore/Mail.php

Lines 53 to 61 in b814c70

	$storedRecipients = array_filter(explode(';', $document->getTo()));
	foreach ($storedRecipients as $multiRecipient) {
	$toRecipients[] = [$multiRecipient, ''];
	}
	}
	foreach ($toRecipients as $recipient) {
	$this->addTo($recipient[0], $recipient[1]);
	}

Which is just a duplicate of pimcores internal mail processor:

https://github.com/pimcore/pimcore/blob/3b9af529ec41cc6a9723dde96714df67b65d6078/lib/Mail.php#L378-L382

[dpfaffenbauer]

where does pimcore add the to again?

[solverat]

@dpfaffenbauer: Pimcore doesn't, CoreShop does. Because coreshop uses the $mail->setDocument(), pimcore internally calls setDocumentSettings() which applies all recipients.

After that, coreshop also adds them here:

CoreShop/src/CoreShop/Component/Pimcore/Mail.php

Lines 53 to 61 in b814c70

	$storedRecipients = array_filter(explode(';', $document->getTo()));
	foreach ($storedRecipients as $multiRecipient) {
	$toRecipients[] = [$multiRecipient, ''];
	}
	}
	foreach ($toRecipients as $recipient) {
	$this->addTo($recipient[0], $recipient[1]);
	}

Most of the time, shop mails property $to is empty, because they should be dynamically sent to the customer. But using notification rules with a defined recipient, the mail will be submitted twice.

[dpfaffenbauer]

So we should stop adding that then right? or at least check for duplicates?

[solverat]

Removing this part should be safe, I guess?

CoreShop/src/CoreShop/Component/Pimcore/Mail.php

Lines 51 to 57 in b814c70

	if ($document instanceof Email) {
	//now add recipients from emailDocument, if given.
	$storedRecipients = array_filter(explode(';', $document->getTo()));
	foreach ($storedRecipients as $multiRecipient) {
	$toRecipients[] = [$multiRecipient, ''];
	}
	}

This part is covered in MailProcessor->setDocument() which triggers the setDocumentSettings() method.