Support Twig, TO, CC, BCC, FROM, REPLY-TO, SUBJECT, Message, Abort, Debugging and Tips

These additions are great.
Thanks a lot.

I did have a bit of a problem though.

I am wanting to send html emails.
I removed the line:
$email_message = PlainTextOutput::renderFromHtml($email_message);

And I also had to set the content-type header:
$data['params']['headers']['Content-Type'] = 'text/html; charset=UTF-8';

Thank you for your great work on this @diamondsea ! This should definitely be part of the CMN module. I am using SMTP for the email functionality. Emails are sent out successfully after I edit content. After I edit content however, I get this error:

Notice: Undefined variable: content_type in Drupal\smtp\Plugin\Mail\SMTPMailSystem->mail() (line 294 of modules/contrib/smtp/src/Plugin/Mail/SMTPMailSystem.php).

After digging into that part of the SMTP module's code, it seems that the error is related to headers.

Adding $data['params']['headers']['Content-Type'] = 'text/plain; charset=UTF-8'; to the Notification.php file solved that issue.

Adding a text/plain content-type header will break it for mime mail users, notice I had to hard code it to text/html as I am using mime mails.
It somehow needs to be dynamic or selectable.

Just one thing with replacing the headers in content_moderation_notifications_mail(), as this seems to replacing a bunch of headers set in core that we'd like to keep.

Can instead do this:
CODE

so we're only adding/replacing the ones in our $params['headers'], without affecting any extra headers in $message['headers'] that we're unaware of.

Patch attached.

Here is my patch describing what I added in comment #10

I wonder if we could split the Twig support out into a separate issue? This patch is attempting to change quite a bit all at once.

In Content Moderation Notifications, which token is efficient for the contributor to be notified ? (we do not want to notify the original author but the person who edited and modified the content after) we tested with those token : {{ user.email }}, [latest_revision_author:mail], [latest_revision_author:email], {{ revision-user:mail }}, [current-user:mail]
(even though after installing the patch https://www.drupal.org/project/content_moderation_notifications/issues/2...), but no one work. An idea ?

I just want to mention that this patch blocks other patches like 3015276. I guess it's because it changes so much code of the original module...

With #17 installed I get this error on every attempt to create node or block. The creation fails with a WSOD. It goes away after removing the patch.

TypeError: Argument 6 passed to Drupal\content_moderation_notifications\Notification::__construct() must implement interface Drupal\Core\Config\ConfigFactoryInterface, instance of Drupal\token\TokenEntityMapper given, called in /var/www/html/web/core/lib/Drupal/Component/DependencyInjection/Container.php on line 282 in Drupal\content_moderation_notifications\Notification->__construct() (line 92 of /var/www/html/web/modules/contrib/content_moderation_notifications/src/Notification.php)

#0 /var/www/html/web/core/lib/Drupal/Component/DependencyInjection/Container.php(282): Drupal\content_moderation_notifications\Notification->__construct(Object(Drupal\Core\Session\AccountProxy), Object(Drupal\Core\Entity\EntityTypeManager), Object(Drupal\Core\Mail\MailManager), Object(Drupal\Core\Extension\ModuleHandler), Object(Drupal\content_moderation_notifications\NotificationInformation), Object(Drupal\token\TokenEntityMapper))
#1 /var/www/html/web/core/lib/Drupal/Component/DependencyInjection/Container.php(171): Drupal\Component\DependencyInjection\Container->createService(Array, 'content_moderat...')
#2 /var/www/html/web/core/lib/Drupal.php(158): Drupal\Component\DependencyInjection\Container->get('content_moderat...')
#3 /var/www/html/web/modules/contrib/content_moderation_notifications/content_moderation_notifications.module(33): Drupal::service('content_moderat...')
#4 [internal function]: content_moderation_notifications_entity_insert(Object(Drupal\block_content\Entity\BlockContent))
#5 /var/www/html/web/core/lib/Drupal/Core/Extension/ModuleHandler.php(403): call_user_func_array('content_moderat...', Array)
#6 /var/www/html/web/core/lib/Drupal/Core/Entity/EntityStorageBase.php(206): Drupal\Core\Extension\ModuleHandler->invokeAll('entity_insert', Array)
#7 /var/www/html/web/core/lib/Drupal/Core/Entity/ContentEntityStorageBase.php(756): Drupal\Core\Entity\EntityStorageBase->invokeHook('insert', Object(Drupal\block_content\Entity\BlockContent))
#8 /var/www/html/web/core/lib/Drupal/Core/Entity/EntityStorageBase.php(507): Drupal\Core\Entity\ContentEntityStorageBase->invokeHook('insert', Object(Drupal\block_content\Entity\BlockContent))
#9 /var/www/html/web/core/lib/Drupal/Core/Entity/ContentEntityStorageBase.php(641): Drupal\Core\Entity\EntityStorageBase->doPostSave(Object(Drupal\block_content\Entity\BlockContent), false)
#10 /var/www/html/web/core/lib/Drupal/Core/Entity/EntityStorageBase.php(432): Drupal\Core\Entity\ContentEntityStorageBase->doPostSave(Object(Drupal\block_content\Entity\BlockContent), false)
#11 /var/www/html/web/core/lib/Drupal/Core/Entity/Sql/SqlContentEntityStorage.php(774): Drupal\Core\Entity\EntityStorageBase->save(Object(Drupal\block_content\Entity\BlockContent))
#12 /var/www/html/web/core/lib/Drupal/Core/Entity/Entity.php(390): Drupal\Core\Entity\Sql\SqlContentEntityStorage->save(Object(Drupal\block_content\Entity\BlockContent))
#13 /var/www/html/web/core/modules/block_content/src/BlockContentForm.php(49): Drupal\Core\Entity\Entity->save()
#14 [internal function]: Drupal\block_content\BlockContentForm->save(Array, Object(Drupal\Core\Form\FormState))
#15 /var/www/html/web/core/lib/Drupal/Core/Form/FormSubmitter.php(111): call_user_func_array(Array, Array)
#16 /var/www/html/web/core/lib/Drupal/Core/Form/FormSubmitter.php(51): Drupal\Core\Form\FormSubmitter->executeSubmitHandlers(Array, Object(Drupal\Core\Form\FormState))
#17 /var/www/html/web/core/lib/Drupal/Core/Form/FormBuilder.php(589): Drupal\Core\Form\FormSubmitter->doSubmitForm(Array, Object(Drupal\Core\Form\FormState))
#18 /var/www/html/web/core/lib/Drupal/Core/Form/FormBuilder.php(318): Drupal\Core\Form\FormBuilder->processForm('block_content_b...', Array, Object(Drupal\Core\Form\FormState))
#19 /var/www/html/web/core/lib/Drupal/Core/Entity/EntityFormBuilder.php(48): Drupal\Core\Form\FormBuilder->buildForm('block_content_b...', Object(Drupal\Core\Form\FormState))
#20 /var/www/html/web/core/modules/block_content/src/Controller/BlockContentController.php(114): Drupal\Core\Entity\EntityFormBuilder->getForm(Object(Drupal\block_content\Entity\BlockContent))
#21 [internal function]: Drupal\block_content\Controller\BlockContentController->addForm(Object(Drupal\block_content\Entity\BlockContentType), Object(Symfony\Component\HttpFoundation\Request))
#22 /var/www/html/web/core/lib/Drupal/Core/EventSubscriber/EarlyRenderingControllerWrapperSubscriber.php(123): call_user_func_array(Array, Array)
#23 /var/www/html/web/core/lib/Drupal/Core/Render/Renderer.php(582): Drupal\Core\EventSubscriber\EarlyRenderingControllerWrapperSubscriber->Drupal\Core\EventSubscriber\{closure}()
#24 /var/www/html/web/core/lib/Drupal/Core/EventSubscriber/EarlyRenderingControllerWrapperSubscriber.php(124): Drupal\Core\Render\Renderer->executeInRenderContext(Object(Drupal\Core\Render\RenderContext), Object(Closure))
#25 /var/www/html/web/core/lib/Drupal/Core/EventSubscriber/EarlyRenderingControllerWrapperSubscriber.php(97): Drupal\Core\EventSubscriber\EarlyRenderingControllerWrapperSubscriber->wrapControllerExecutionInRenderContext(Array, Array)
#26 /var/www/html/vendor/symfony/http-kernel/HttpKernel.php(151): Drupal\Core\EventSubscriber\EarlyRenderingControllerWrapperSubscriber->Drupal\Core\EventSubscriber\{closure}()
#27 /var/www/html/vendor/symfony/http-kernel/HttpKernel.php(68): Symfony\Component\HttpKernel\HttpKernel->handleRaw(Object(Symfony\Component\HttpFoundation\Request), 1)
#28 /var/www/html/web/core/lib/Drupal/Core/StackMiddleware/Session.php(57): Symfony\Component\HttpKernel\HttpKernel->handle(Object(Symfony\Component\HttpFoundation\Request), 1, true)
#29 /var/www/html/web/core/lib/Drupal/Core/StackMiddleware/KernelPreHandle.php(47): Drupal\Core\StackMiddleware\Session->handle(Object(Symfony\Component\HttpFoundation\Request), 1, true)
#30 /var/www/html/web/core/modules/page_cache/src/StackMiddleware/PageCache.php(99): Drupal\Core\StackMiddleware\KernelPreHandle->handle(Object(Symfony\Component\HttpFoundation\Request), 1, true)
#31 /var/www/html/web/core/modules/page_cache/src/StackMiddleware/PageCache.php(78): Drupal\page_cache\StackMiddleware\PageCache->pass(Object(Symfony\Component\HttpFoundation\Request), 1, true)
#32 /var/www/html/web/core/lib/Drupal/Core/StackMiddleware/ReverseProxyMiddleware.php(47): Drupal\page_cache\StackMiddleware\PageCache->handle(Object(Symfony\Component\HttpFoundation\Request), 1, true)
#33 /var/www/html/web/core/lib/Drupal/Core/StackMiddleware/NegotiationMiddleware.php(52): Drupal\Core\StackMiddleware\ReverseProxyMiddleware->handle(Object(Symfony\Component\HttpFoundation\Request), 1, true)
#34 /var/www/html/vendor/stack/builder/src/Stack/StackedHttpKernel.php(23): Drupal\Core\StackMiddleware\NegotiationMiddleware->handle(Object(Symfony\Component\HttpFoundation\Request), 1, true)
#35 /var/www/html/web/core/lib/Drupal/Core/DrupalKernel.php(665): Stack\StackedHttpKernel->handle(Object(Symfony\Component\HttpFoundation\Request), 1, true)
#36 /var/www/html/web/index.php(19): Drupal\Core\DrupalKernel->handle(Object(Symfony\Component\HttpFoundation\Request))
#37 {main}

seems to be working for me. Thanks all!

I updated patch 17 to:

• Use Drupal\Core\Url instead of Drupal\Core\URL to fix failed tests.
• If two notifications were created on the same transition, the body from the first would still be in the first entry of $data['params']['body'] for the second.
• Implemented TODO for using state label instead of state ID.

Updated #28 so that the body of the email created was still an array.

patch in 17 and 29 no longer applied to latest version. rerolling

reroll for 3.2 only
this patch does not apply to dev

I couldn't get any of the patches from 2019 to apply, and didn't try any of the 2018 ones. I'm running 3.x-dev on Drupal 8.8.1.

Any update on re-rolling this patch? Patch 32 failed for me too.

Updated the patch to work with Version 8.x-3.3.

Updated the patch to work with Version 8.x-3.3. Resolved multiple notifications not being generated.

I could apply #36 with the 3.3 version. I cleared the caches, ran cron and did the db updates.
I still don't have all the fields, this is pretty strange. Here is what I have:

@hgupta28 The patch needs to be provided for the 8.x-3.x branch (the one used for the 8.x-3.x-dev development snapshot). When fixing bugs or implementing code for a feature request, it's the branch code that is changed.

Not sure if this patch will ever be committed. @jhedstrom suggested in #19 (3 yrs ago) to split off the twig functionality.

@anruether the scope of this issue is too wide to really be able to be properly reviewed, tested and committed as a whole. It would have to be split out into much smaller patches each focusing on specific elements to be dealt with in isolation to get to the point where it can be added to a release etc.

Once aspects are completed separately they can be removed from this patch until this patch is no longer necessary.

I agree: A 54 KB patch is too wide to be properly handled.
I would split the issue and keep in this the code that is common to all the issues, if such code exists.

Agreed with #19 and #39-#41. This patch is way too big and changing way too many things to be reviewed, tested and committed in one shot. We need to split this up into child issues of more manageable scope. As-is, this will never be committed. Tagging for rescope and summary update.

https://www.drupal.org/docs/develop/issues/issue-procedures-and-etiquett... for the interested reader. 😉 While that's specific to core, the principles are generally applicable.

Thanks,
-Derek

For starters, I re-opened #2953489-13: Add Twig support in Subject, Email, and Message fields and posted a patch there (with tests) for Twig support in body, subject and to (adhoc 'emails') fields. Reviews most welcome!

Thanks,
-Derek

p.s. Turning this issue into an active 'plan', and put #2953489 as a child. This summary/issue still needs major help, so leaving it tagged for such.

Just re-uploading the patch from #36 with deprecated code replaced (for D9-compatibility).

@khaled.zaidan See the previous comments: Patches should not be provided for this issue, which is categorized as plan.

All of this stuff would be ideal - especially being able to use twig in the message body.

Re #47: you already can. See #2953489: Add Twig support in Subject, Email, and Message fields

Since Twig support was already added, the next step here would be to split out more of this work into additional separate issues to make them easier to review and merge in.

Note that there's another issue for adding support for more control of the To, Cc, Bcc, etc. headers: #3273627: Provide full to/cc/bcc email configuration. I haven't compared the implementation details of that issue with this one yet but I plan to.

The other functionality of this (abort support, debugging, tips, etc.) should all be split out into separate issues.