Modifying the $message['key'] variable in hook_mail_alter does not change the mail key

Created on 23 January 2024, 10 months ago

Updated 25 January 2024, 10 months ago

The issue is that $message['key'] is available in the hook_mail_alter hook, but it cannot be changed. It would be beneficial to make this possible, as it could be useful in certain scenarios. For example, when using the Mail System → module, we can configure mail formatter or sender by $message['key'], but I believe this flexibility could be helpful for other modules as well.

MailManager.php

    // Bundle up the variables into a structured array for altering.
    $message = [
      'id' => $module . '_' . $key,
      'module' => $module,
      'key' => $key,
      'to' => $to,
      'from' => $site_mail,
      'reply-to' => $reply,
      'langcode' => $langcode,
      'params' => $params,
      'send' => TRUE,
      'subject' => '',
      'body' => [],
    ];

...

    // Build the email (get subject and body, allow additional headers) by
    // invoking hook_mail() on this module.
    $this->moduleHandler->invoke($module, 'mail', [$key, &$message, $params]);

    // Invoke hook_mail_alter() to allow all modules to alter the resulting
    // email.
    $this->moduleHandler->alter('mail', $message);

    // Retrieve the responsible implementation for this message.
    $system = $this->getInstance(['module' => $module, 'key' => $key]);

🐛 Bug report

Status

Needs work

Version

10.1 ✨

Component

Mail →

Last updated 14 days ago

No maintainer

Created by

dejan0

Live updates comments and jobs are added and updated live.

Needs tests
The change is currently missing an automated test that fails when run with the original code, and succeeds when the bug has been fixed.

Needs issue summary update
Issue summaries save everyone time if they are kept up-to-date. See Update issue summary task instructions.

Comments & Activities

Issue created by @dejan0
Status changed to Needs review 10 months ago10:00am 23 January 2024
Comment 10 months ago →
dejan0
The small patch is available here. However, upon further consideration, I'm unsure if it's a good idea to allow this to be changed. Modules typically use it in hook_mail() to filter out their messages. Allowing other modules to change it in between might not be ideal. Let's see what others think.
Open in Jenkins → Open on Drupal.org →
Environment: PHP 8.2 & MySQL 8
last update 10 months ago
29,722 pass
Status changed to Needs work 10 months ago2:24pm 25 January 2024
Comment 10 months ago →
🇺🇸United States smustgrave
Issue summary should be updated with the standard template with all sections. Even if they don't apply it's easier for committer to see N/A vs it not being there.

Also will need a failing test to show this issue.

Thanks for reporting!

contrib.social Blog FAQ Discussions

Production build 0.71.5 2024