function update_mail
Same name in other branches
- 7.x modules/update/update.module \update_mail()
- 9 core/modules/update/update.module \update_mail()
- 10 core/modules/update/update.module \update_mail()
- 11.x core/modules/update/update.module \update_mail()
Implements hook_mail().
Constructs the email notification message when the site is out of date.
Parameters
$key: Unique key to indicate what message to build, always 'status_notify'.
$message: Reference to the message array being built.
$params: Array of parameters to indicate what kind of text to include in the message body. This is a keyed array of message type ('core' or 'contrib') as the keys, and the status reason constant (UpdateManagerInterface::NOT_SECURE, etc) for the values.
See also
\Drupal\Core\Mail\MailManagerInterface::mail()
\Drupal\update\UpdateManagerInterface
File
-
core/
modules/ update/ update.module, line 534
Code
function update_mail($key, &$message, $params) {
$langcode = $message['langcode'];
$language = \Drupal::languageManager()->getLanguage($langcode);
$message['subject'] .= t('New release(s) available for @site_name', [
'@site_name' => \Drupal::config('system.site')->get('name'),
], [
'langcode' => $langcode,
]);
foreach ($params as $msg_type => $msg_reason) {
$message['body'][] = _update_message_text($msg_type, $msg_reason, $langcode);
}
$message['body'][] = t('See the available updates page for more information:', [], [
'langcode' => $langcode,
]) . "\n" . Url::fromRoute('update.status', [], [
'absolute' => TRUE,
'language' => $language,
])->toString();
if (_update_manager_access()) {
$message['body'][] = t('You can automatically install your missing updates using the Update manager:', [], [
'langcode' => $langcode,
]) . "\n" . Url::fromRoute('update.report_update', [], [
'absolute' => TRUE,
'language' => $language,
])->toString();
}
$settings_url = Url::fromRoute('update.settings', [], [
'absolute' => TRUE,
])->toString();
if (\Drupal::config('update.settings')->get('notification.threshold') == 'all') {
$message['body'][] = t('Your site is currently configured to send these emails when any updates are available. To get notified only for security updates, @url.', [
'@url' => $settings_url,
]);
}
else {
$message['body'][] = t('Your site is currently configured to send these emails only when security updates are available. To get notified for any available updates, @url.', [
'@url' => $settings_url,
]);
}
}
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.