Mime messages #30416
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,100 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * This file is part of the Symfony package. | ||
| * | ||
| * (c) Fabien Potencier <fabien@symfony.com> | ||
| * | ||
| * For the full copyright and license information, please view the LICENSE | ||
| * file that was distributed with this source code. | ||
| */ | ||
|
|
||
| namespace Symfony\Bridge\Twig\Mime; | ||
|
|
||
| use League\HTMLToMarkdown\HtmlConverter; | ||
| use Twig\Environment; | ||
|
|
||
| /** | ||
| * @author Fabien Potencier <fabien@symfony.com> | ||
| * | ||
| * @experimental in 4.3 | ||
| */ | ||
| final class Renderer | ||
| { | ||
| private $twig; | ||
| private $context; | ||
| private $converter; | ||
|
|
||
| public function __construct(Environment $twig, array $context = []) | ||
| { | ||
| $this->twig = $twig; | ||
| $this->context = $context; | ||
| if (class_exists(HtmlConverter::class)) { | ||
fabpot marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| $this->converter = new HtmlConverter([ | ||
|
There was a problem hiding this comment. How could we provide autodiscovery for this? There was a problem hiding this comment. That seems like a good place to start - throw an exception when/if it's used (in
There was a problem hiding this comment. I like your suggestion @weaverryan, can you create a PR for it? |
||
| 'hard_break' => true, | ||
| 'strip_tags' => true, | ||
| 'remove_nodes' => 'head style', | ||
| ]); | ||
| } | ||
| } | ||
|
|
||
| public function render(TemplatedEmail $email): TemplatedEmail | ||
| { | ||
| $email = clone $email; | ||
|
|
||
| $vars = array_merge($this->context, $email->getContext(), [ | ||
| 'email' => new WrappedTemplatedEmail($this->twig, $email), | ||
| ]); | ||
|
|
||
| if ($template = $email->getTemplate()) { | ||
| $this->renderFull($email, $template, $vars); | ||
| } | ||
|
|
||
| if ($template = $email->getTextTemplate()) { | ||
| $email->text($this->twig->render($template, $vars)); | ||
| } | ||
|
|
||
| if ($template = $email->getHtmlTemplate()) { | ||
| $email->html($this->twig->render($template, $vars)); | ||
| } | ||
|
|
||
| // if text body is empty, compute one from the HTML body | ||
| if (!$email->getTextBody() && null !== $html = $email->getHtmlBody()) { | ||
| $email->text($this->convertHtmlToText(\is_resource($html) ? stream_get_contents($html) : $html)); | ||
| } | ||
|
|
||
| return $email; | ||
| } | ||
|
|
||
| private function renderFull(TemplatedEmail $email, string $template, array $vars): void | ||
| { | ||
| $template = $this->twig->load($template); | ||
|
|
||
| if ($template->hasBlock('subject', $vars)) { | ||
| $email->subject($template->renderBlock('subject', $vars)); | ||
| } | ||
|
|
||
| if ($template->hasBlock('text', $vars)) { | ||
| $email->text($template->renderBlock('text', $vars)); | ||
| } | ||
|
|
||
| if ($template->hasBlock('html', $vars)) { | ||
| $email->html($template->renderBlock('html', $vars)); | ||
| } | ||
|
|
||
| if ($template->hasBlock('config', $vars)) { | ||
| // we discard the output as we're only interested | ||
| // in the side effect of calling email methods | ||
| $template->renderBlock('config', $vars); | ||
| } | ||
| } | ||
|
|
||
| private function convertHtmlToText(string $html): string | ||
| { | ||
| if (null !== $this->converter) { | ||
| return $this->converter->convert($html); | ||
| } | ||
|
|
||
| return strip_tags($html); | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,87 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * This file is part of the Symfony package. | ||
| * | ||
| * (c) Fabien Potencier <fabien@symfony.com> | ||
| * | ||
| * For the full copyright and license information, please view the LICENSE | ||
| * file that was distributed with this source code. | ||
| */ | ||
|
|
||
| namespace Symfony\Bridge\Twig\Mime; | ||
|
|
||
| use Symfony\Component\Mime\Email; | ||
|
|
||
| /** | ||
| * @author Fabien Potencier <fabien@symfony.com> | ||
| * | ||
| * @experimental in 4.3 | ||
| */ | ||
| class TemplatedEmail extends Email | ||
| { | ||
| private $template; | ||
| private $htmlTemplate; | ||
| private $textTemplate; | ||
| private $context = []; | ||
|
|
||
| /** | ||
| * @return $this | ||
| */ | ||
| public function template(?string $template) | ||
| { | ||
| $this->template = $template; | ||
|
|
||
| return $this; | ||
| } | ||
|
|
||
| /** | ||
| * @return $this | ||
| */ | ||
| public function textTemplate(?string $template) | ||
| { | ||
| $this->textTemplate = $template; | ||
|
|
||
| return $this; | ||
| } | ||
|
|
||
| /** | ||
| * @return $this | ||
| */ | ||
| public function htmlTemplate(?string $template) | ||
| { | ||
| $this->htmlTemplate = $template; | ||
|
|
||
| return $this; | ||
| } | ||
|
|
||
| public function getTemplate(): ?string | ||
| { | ||
| return $this->template; | ||
| } | ||
|
|
||
| public function getTextTemplate(): ?string | ||
| { | ||
| return $this->textTemplate; | ||
| } | ||
|
|
||
| public function getHtmlTemplate(): ?string | ||
| { | ||
| return $this->htmlTemplate; | ||
| } | ||
|
|
||
| /** | ||
| * @return $this | ||
| */ | ||
| public function context(array $context) | ||
| { | ||
| $this->context = $context; | ||
|
|
||
| return $this; | ||
| } | ||
|
|
||
| public function getContext(): array | ||
| { | ||
| return $this->context; | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,199 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * This file is part of the Symfony package. | ||
| * | ||
| * (c) Fabien Potencier <fabien@symfony.com> | ||
| * | ||
| * For the full copyright and license information, please view the LICENSE | ||
| * file that was distributed with this source code. | ||
| */ | ||
|
|
||
| namespace Symfony\Bridge\Twig\Mime; | ||
|
|
||
| use Symfony\Component\Mime\Address; | ||
| use Symfony\Component\Mime\NamedAddress; | ||
| use Twig\Environment; | ||
|
|
||
| /** | ||
| * @internal | ||
| * | ||
| * @author Fabien Potencier <fabien@symfony.com> | ||
| * | ||
| * @experimental in 4.3 | ||
| */ | ||
| final class WrappedTemplatedEmail | ||
| { | ||
| private $twig; | ||
| private $message; | ||
|
|
||
| public function __construct(Environment $twig, TemplatedEmail $message) | ||
| { | ||
| $this->twig = $twig; | ||
| $this->message = $message; | ||
| } | ||
|
|
||
| public function toName(): string | ||
| { | ||
| $to = $this->message->getTo()[0]; | ||
|
|
||
| return $to instanceof NamedAddress ? $to->getName() : ''; | ||
| } | ||
|
|
||
| public function image(string $image, string $contentType = null): string | ||
| { | ||
| $file = $this->twig->getLoader()->getSourceContext($image); | ||
| if ($path = $file->getPath()) { | ||
| $this->message->embedFromPath($path, $image, $contentType); | ||
| } else { | ||
| $this->message->embed($file->getCode(), $image, $contentType); | ||
| } | ||
|
|
||
| return 'cid:'.$image; | ||
| } | ||
|
|
||
| public function attach(string $file, string $name = null, string $contentType = null): void | ||
| { | ||
| $file = $this->twig->getLoader()->getSourceContext($file); | ||
| if ($path = $file->getPath()) { | ||
| $this->message->attachFromPath($path, $name, $contentType); | ||
| } else { | ||
| $this->message->attach($file->getCode(), $name, $contentType); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * @return $this | ||
| */ | ||
| public function setSubject(string $subject) | ||
| { | ||
| $this->message->subject($subject); | ||
|
|
||
| return $this; | ||
| } | ||
|
|
||
| public function getSubject(): ?string | ||
| { | ||
| return $this->message->getSubject(); | ||
| } | ||
|
|
||
| /** | ||
| * @return $this | ||
| */ | ||
| public function setReturnPath(string $address) | ||
| { | ||
| $this->message->returnPath($address); | ||
|
|
||
| return $this; | ||
| } | ||
|
|
||
| public function getReturnPath(): string | ||
| { | ||
| return $this->message->getReturnPath(); | ||
| } | ||
|
|
||
| /** | ||
| * @return $this | ||
| */ | ||
| public function addFrom(string $address, string $name = null) | ||
| { | ||
| $this->message->addFrom($name ? new NamedAddress($address, $name) : new Address($address)); | ||
|
|
||
| return $this; | ||
| } | ||
|
|
||
| /** | ||
| * @return (Address|NamedAddress)[] | ||
| */ | ||
| public function getFrom(): array | ||
| { | ||
| return $this->message->getFrom(); | ||
| } | ||
|
|
||
| /** | ||
| * @return $this | ||
| */ | ||
| public function addReplyTo(string $address) | ||
| { | ||
| $this->message->addReplyTo($address); | ||
|
|
||
| return $this; | ||
| } | ||
|
|
||
| /** | ||
| * @return Address[] | ||
| */ | ||
| public function getReplyTo(): array | ||
| { | ||
| return $this->message->getReplyTo(); | ||
| } | ||
|
|
||
| /** | ||
| * @return $this | ||
| */ | ||
| public function addTo(string $address, string $name = null) | ||
| { | ||
| $this->message->addTo($name ? new NamedAddress($address, $name) : new Address($address)); | ||
|
|
||
| return $this; | ||
| } | ||
|
|
||
| /** | ||
| * @return (Address|NamedAddress)[] | ||
| */ | ||
| public function getTo(): array | ||
| { | ||
| return $this->message->getTo(); | ||
| } | ||
|
|
||
| /** | ||
| * @return $this | ||
| */ | ||
| public function addCc(string $address, string $name = null) | ||
| { | ||
| $this->message->addCc($name ? new NamedAddress($address, $name) : new Address($address)); | ||
|
|
||
| return $this; | ||
| } | ||
|
|
||
| /** | ||
| * @return (Address|NamedAddress)[] | ||
| */ | ||
| public function getCc(): array | ||
| { | ||
| return $this->message->getCc(); | ||
| } | ||
|
|
||
| /** | ||
| * @return $this | ||
| */ | ||
| public function addBcc(string $address, string $name = null) | ||
| { | ||
| $this->message->addBcc($name ? new NamedAddress($address, $name) : new Address($address)); | ||
|
|
||
| return $this; | ||
| } | ||
|
|
||
| /** | ||
| * @return (Address|NamedAddress)[] | ||
| */ | ||
| public function getBcc(): array | ||
| { | ||
| return $this->message->getBcc(); | ||
| } | ||
|
|
||
| /** | ||
| * @return $this | ||
| */ | ||
| public function setPriority(int $priority) | ||
| { | ||
| $this->message->setPriority($priority); | ||
|
|
||
| return $this; | ||
| } | ||
|
|
||
| public function getPriority(): int | ||
| { | ||
| return $this->message->getPriority(); | ||
| } | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Where is the class used? Or where do we plan to use it?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I thought you were at my keynote, listening carefully :) Everything is explained in the presentation linked in the description of the PR.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
my core point is related to the design of the class :)
if it's final and has no interface, then type-hinting for it means creating strong coupling, while it could be usefull to provide an alternative implementation (eg another html-to-txt - I used to use
w3mfor that job and it does it nicely)