How can I use one of the pre-set email texts for user registration in a custom module

Question

At /admin/config/people/accounts, there are several stock email messages set.

How can I use one of these when I am sending emails from a custom module?

The text that's being used in "Welcome (new user created by administrator)" is all that I need, plus there's the bonus that our client can edit this email in the future if they want to.

I can send the message easily enough using:

$params = [
   'title' => "My Title",
   'subject' => "An Account Has Been Created for you",
   'message' => Html::escape("Some text here")
 ];

$result = $mailManager->mail($module, $key, $to, $language_code, $params, NULL, true);

Is there a variable somewhere to get the pre-entered text?

Answer 1

I guess this should be possible via configuration API. Look for the suitable entry where the message body is saved, call it via the service to put it into a variable. Then you can do additional coding with the string variable. More information you can find here: Configuration override system in the docs

Answer 2

All emails in Drupal are uniquely identified by their sending module and key. In the case of the welcome message for admin-created users, the sending module is user and the key is register_admin_created. This is all you need. The subject and the message body is defined by the sending module and you don't need access to it in order to send the message.

If you want to send this message from your own module, the correct way to do it is: \Drupal::service('plugin.manager.mail')->mail('user', 'register_admin_created', $to, $langcode); where $to is a string containing the email address of the recipient, and $langcode is a RFC 5646 language code. There are also a few optional parameters you can pass to mail(). See the MailManager::mail() API documentation for more information about how to use mail() and what the arguments mean.

Also note that if you are calling mail() from object-oriented code, you really should inject the plugin.manager.mail service instead of using the static \Drupal call shown above. But explaining that is outside the scope of this question.

Answer 3

Thanks for the guidance on this @dercheffe. I found what I needed in the config file user.mail.yml and was able to pull the strings outs as an array with :

$config_txt = \Drupal::config('user.mail')->get('register_admin_created');

However, I had the problem of how to replace the user and site variables in the strings from the config file.

Long story short, I didn't even need that config information.

The answer was to just use the Drupal function

_user_mail_notify('register_admin_created', $newuser);

The email is sent out based on the text in the configuration to our new user.