Send processing report as reply

Promoting to major since this could be a great value from inmail and removes complexity from custom solutions.

Sure, we need to discuss if this is debug only, if handlers could modify / enrich the response, or suppress / replace it at all.

Yeah a simple first version could to send all the log lines to the source.

Still not sure about the exact additional interface we should define.
The response could have some response object on it.
And the response could have a flag if it should include the log.

Again this is related to the standard result. #2754253: Lack of standard result in collaboration of analyzers
Or we could again introduce another partial interface.

1. +++ b/inmail.module
   +++ b/inmail.module
   @@ -318,6 +318,34 @@ function inmail_mail($key, &$message, $params) {
   
   @@ -318,6 +318,34 @@ function inmail_mail($key, &$message, $params) {
          $message['raw_headers'] = $header;
   ...
   +  $result = $params['original'];
   

   Oh we already have some other mail case...

   So we need a switch statement for $key.

2. +++ b/inmail.module
   @@ -318,6 +318,34 @@ function inmail_mail($key, &$message, $params) {
   +  $status = $result->getStatusLabel();
   +  $subject = strtoupper($status) . ': ' . $result->getValue() . ' ' . $sensor_config->getLabel();
   ...
   +  $message_id = '<' . $result->getSensorId() . '.' . time() . '@' . \Drupal::request()->getHost() . '>';
   

   Remove those lines related to $result or $sensor_* That's more related to a Monitoring result where we copied the code from.

3. +++ b/inmail.module
   @@ -318,6 +318,34 @@ function inmail_mail($key, &$message, $params) {
   +  $message['subject'] = $subject;
   

   We could simply answer with the original subject + "Re: ".

4. +++ b/inmail.module
   @@ -318,6 +318,34 @@ function inmail_mail($key, &$message, $params) {
   +  // Set the mail sender.
   +  $site_config = \Drupal::config('system.site');
   +  $site_mail = $site_config->get('mail');
   +  $site_name = $site_config->get('name');
   +  $message['from'] = 'INMAIL ' . $site_name . ' <' . $site_mail . '>';
   

   Simply remove. The standard from is OK.

5. +++ b/inmail.module
   @@ -318,6 +318,34 @@ function inmail_mail($key, &$message, $params) {
   +  $message['headers']['message-id'] = $message_id;
   

   We should add a reference to the original message-id here.

6. +++ b/src/MessageProcessor.php
   @@ -168,6 +168,14 @@ class MessageProcessor implements MessageProcessorInterface {
   +      $mail_manager->mail('inmail_success', 'Success', $recipient, \Drupal::languageManager()->getDefaultLanguage()->getId(), $params);
   

   It's $module and $key. So it's "success" and not "Success".

And as discussed, make sending this mail a configuration setting of the deliverer.

1. +++ b/src/MessageProcessor.php
   @@ -168,6 +168,17 @@ class MessageProcessor implements MessageProcessorInterface {
   +      if ($deliverer->isMessageReport()) {
   

   Check this first and only do the lines above inside the if().

2. +++ b/tests/src/Kernel/ModeratorForwardTest.php
   @@ -94,6 +94,17 @@ class ModeratorForwardTest extends KernelTestBase {
   +    $mail = $this->getMails();
   

   mail => mails. I would recommend that you assign the mail in question:
   $mail = $mails[0]

3. +++ b/tests/src/Kernel/ModeratorForwardTest.php
   @@ -94,6 +94,17 @@ class ModeratorForwardTest extends KernelTestBase {
   +    $this->assertEquals('Re: BMH testing sample', $mail[0]['subject']);
   

   That's an awesome example...
   Because it reminds me that we will for sure NOT send a mail to the sender in case the mail is classified as a bounce...
   Otherwise we will create mail loops.

4. +++ b/inmail.module
   @@ -317,6 +317,23 @@ function inmail_mail($key, &$message, $params) {
   +      $body [] = 'The message has been processed successfully.';
   

   Let's add some more data such as:
   - Original message date
   Anything else to mention in the body?

5. +++ b/inmail.module
   @@ -317,6 +317,23 @@ function inmail_mail($key, &$message, $params) {
   +      // We can use here Kerims function 'inmail_get_log_message'
   

   OK we can do this in a follow-up. But please remove the garbage comment lines. Just add a clean @todo and a link to the issue where the method is added.

6. +++ b/src/Entity/DelivererConfig.php
   @@ -32,6 +32,7 @@ use Drupal\inmail\DelivererConfigInterface;
     *     "configuration",
   + *     "message_report" = "message_report",
   

   There's no "= ..."

1. +++ b/inmail.module
   @@ -319,6 +319,17 @@ function inmail_mail($key, &$message, $params) {
   +      $message['from'] = \Drupal::config('system.site')->get('mail');
   

   The site is the from by default. You don't need to state that. Also, it is improved over your code because it's the site name as display name.

2. +++ b/inmail.module
   @@ -319,6 +319,17 @@ function inmail_mail($key, &$message, $params) {
   +      $message['headers']['message-id'] = $original->getMessageId();
   

   still unchanged. see my comments above.

3. +++ b/src/MessageProcessor.php
   @@ -168,6 +168,18 @@ class MessageProcessor implements MessageProcessorInterface {
   +      if ($deliverer->isMessageReport()) {
   
   +++ b/tests/src/Kernel/ModeratorForwardTest.php
   @@ -94,6 +94,17 @@ class ModeratorForwardTest extends KernelTestBase {
   +    $this->assertMailCount(1);
   ...
   +    $this->assertEquals('bounces@example.com', $last_mail['from']);
   +    $this->assertEquals('Re: BMH testing sample', $last_mail['subject']);
   

   You still need to make sure that messages classified as bounce are not triggering a mail.

   Something like

   +      if ($deliverer->isMessageReport() && !$message->isBounce()) {
   

   And even if "send report" is enabled, you want to make sure in tests that when processing a bounce, no mail went out.

+++ b/src/MessageProcessor.php
@@ -195,6 +197,37 @@ class MessageProcessor implements MessageProcessorInterface {
+    if ( $default_result->hasContext('bounce')) {
+      $bounce_data = $default_result->getContext('bounce')->getContextData();
+      if ($deliverer->isMessageReport() && !$bounce_data->isBounce()) {

This is not correct.

Even if the bounce context doesn't exist, such as when the BounceAnalyzer is disabled, the mail should be sent.
It should only be skipped if the context explicitly exists and confirms isBounce().

+++ b/tests/src/Kernel/ModeratorForwardTest.php
@@ -108,6 +109,31 @@ class ModeratorForwardTest extends KernelTestBase {
+    $this->assertEquals('bounces@example.com', $last_mail['from']);

Where is this from...This is misleading, but it's already defined in setUp(). :-)

Committed with lots of small fixes.