View source
<?php
namespace Drupal\Tests\system\Kernel\Mail;
use Drupal\Component\Utility\Random;
use Drupal\Core\File\FileSystemInterface;
use Drupal\Core\Mail\MailFormatHelper;
use Drupal\Core\Mail\Plugin\Mail\TestMailCollector;
use Drupal\Core\Messenger\MessengerInterface;
use Drupal\Core\Render\Markup;
use Drupal\Core\Url;
use Drupal\file\Entity\File;
use Drupal\KernelTests\KernelTestBase;
use Drupal\system_mail_failure_test\Plugin\Mail\TestPhpMailFailure;
class MailTest extends KernelTestBase {
protected static $modules = [
'file',
'image',
'mail_cancel_test',
'mail_html_test',
'system',
'system_mail_failure_test',
'user',
];
protected function setUp() : void {
parent::setUp();
$this
->installEntitySchema('user');
$this
->installEntitySchema('file');
}
public function testPluggableFramework() {
$this
->configureDefaultMailInterface('test_php_mail_failure');
$mail_backend = \Drupal::service('plugin.manager.mail')
->getInstance([
'module' => 'default',
'key' => 'default',
]);
$this
->assertInstanceOf(TestPhpMailFailure::class, $mail_backend);
$this
->config('system.mail')
->set('interface.mymodule_testkey', 'test_mail_collector')
->save();
$mail_backend = \Drupal::service('plugin.manager.mail')
->getInstance([
'module' => 'mymodule',
'key' => 'testkey',
]);
$this
->assertInstanceOf(TestMailCollector::class, $mail_backend);
}
public function testErrorMessageDisplay() {
$this
->configureDefaultMailInterface('test_php_mail_failure');
\Drupal::service('plugin.manager.mail')
->mail('default', 'default', 'test@example.com', 'en');
$messages = \Drupal::messenger()
->messagesByType(MessengerInterface::TYPE_ERROR);
$this
->assertEquals('Unable to send email. Contact the site administrator if the problem persists.', $messages[0]);
\Drupal::messenger()
->deleteAll();
\Drupal::service('plugin.manager.mail')
->mail('default', 'default', 'test@example.com', 'en', [
'_error_message' => '',
]);
$this
->assertEmpty(\Drupal::messenger()
->messagesByType(MessengerInterface::TYPE_ERROR));
}
public function testCancelMessage() {
$language_interface = \Drupal::languageManager()
->getCurrentLanguage();
\Drupal::state()
->set('system.test_mail_collector', []);
\Drupal::service('plugin.manager.mail')
->mail('mail_cancel_test', 'cancel_test', 'cancel@example.com', $language_interface
->getId());
$captured_emails = \Drupal::state()
->get('system.test_mail_collector');
$sent_message = end($captured_emails);
$this
->assertFalse($sent_message);
}
public function testFromAndReplyToHeader() {
$language = \Drupal::languageManager()
->getCurrentLanguage();
$this
->config('system.site')
->set('mail', 'mailtest@example.com')
->set('name', 'Drupal')
->save();
\Drupal::state()
->set('system.test_mail_collector', []);
$from_email = 'Drupal <mailtest@example.com>';
$reply_email = 'someone_else@example.com';
\Drupal::service('plugin.manager.mail')
->mail('mail_cancel_test', 'from_test', 'from_test@example.com', $language, [], $reply_email);
$captured_emails = \Drupal::state()
->get('system.test_mail_collector');
$sent_message = end($captured_emails);
$this
->assertEquals($from_email, $sent_message['headers']['From']);
$this
->assertEquals($reply_email, $sent_message['headers']['Reply-to']);
$this
->assertFalse(isset($sent_message['headers']['Errors-To']));
$this
->config('system.site')
->set('name', 'Drépal this is a very long test sentence to test what happens with very long site names')
->save();
\Drupal::service('plugin.manager.mail')
->mail('mail_cancel_test', 'from_test', 'from_test@example.com', $language);
$captured_emails = \Drupal::state()
->get('system.test_mail_collector');
$sent_message = end($captured_emails);
$this
->assertEquals('=?utf-8?Q?Dr=C3=A9pal?= this is a very long test sentence to test what happens with very long site names <mailtest@example.com>', $sent_message['headers']['From']);
$this
->assertEquals('Drépal this is a very long test sentence to test what happens with very long site names <mailtest@example.com>', iconv_mime_decode($sent_message['headers']['From']));
$this
->assertFalse(isset($sent_message['headers']['Reply-to']), 'Message reply-to is not set if not specified.');
$this
->assertFalse(isset($sent_message['headers']['Errors-To']));
$specials = '()<>[]:;@\\,."';
$site_name = 'Drupal' . $specials[rand(0, strlen($specials) - 1)] . ' "si\\te"';
$this
->config('system.site')
->set('name', $site_name)
->save();
\Drupal::service('plugin.manager.mail')
->mail('mail_cancel_test', 'from_test', 'from_test@example.com', $language);
$captured_emails = \Drupal::state()
->get('system.test_mail_collector');
$sent_message = end($captured_emails);
$escaped_site_name = str_replace([
'\\',
'"',
], [
'\\\\',
'\\"',
], $site_name);
$this
->assertEquals('"' . $escaped_site_name . '" <mailtest@example.com>', $sent_message['headers']['From']);
$site_name = 'Drépal, "si\\te"';
$this
->config('system.site')
->set('name', $site_name)
->save();
\Drupal::service('plugin.manager.mail')
->mail('mail_cancel_test', 'from_test', 'from_test@example.com', $language);
$captured_emails = \Drupal::state()
->get('system.test_mail_collector');
$sent_message = end($captured_emails);
$this
->assertEquals('=?utf-8?Q?Dr=C3=A9pal=2C_=22si=5Cte=22?= <mailtest@example.com>', $sent_message['headers']['From']);
$this
->assertEquals($site_name . ' <mailtest@example.com>', iconv_mime_decode($sent_message['headers']['From']));
}
public function testConvertRelativeUrlsIntoAbsolute() {
$language_interface = \Drupal::languageManager()
->getCurrentLanguage();
$this
->configureDefaultMailInterface('test_html_mail_collector');
$http_host = \Drupal::request()
->getSchemeAndHttpHost();
$random = new Random();
$tag_name = strtolower($random
->name(8, TRUE));
foreach ([
'href',
'src',
] as $attribute) {
\Drupal::state()
->set('system.test_mail_collector', []);
$html = "<{$tag_name} {$attribute}=\"/root-relative\">root relative url in mail test</{$tag_name}>";
$expected_html = "<{$tag_name} {$attribute}=\"{$http_host}/root-relative\">root relative url in mail test</{$tag_name}>";
$render = [
'#markup' => Markup::create($html),
];
\Drupal::service('plugin.manager.mail')
->mail('mail_html_test', 'render_from_message_param', 'relative_url@example.com', $language_interface
->getId(), [
'message' => $render,
]);
$captured_emails = \Drupal::state()
->get('system.test_mail_collector');
$sent_message = end($captured_emails);
$expected_html = MailFormatHelper::wrapMail($expected_html);
$this
->assertSame($expected_html, $sent_message['body'], "Asserting that {$attribute} is properly converted for mails.");
}
foreach ([
'href',
'src',
] as $attribute) {
\Drupal::state()
->set('system.test_mail_collector', []);
$html = "<{$tag_name} {$attribute}=\"//example.com/protocol-relative\">protocol relative url in mail test</{$tag_name}>";
$expected_html = "<{$tag_name} {$attribute}=\"//example.com/protocol-relative\">protocol relative url in mail test</{$tag_name}>";
$render = [
'#markup' => Markup::create($html),
];
\Drupal::service('plugin.manager.mail')
->mail('mail_html_test', 'render_from_message_param', 'relative_url@example.com', $language_interface
->getId(), [
'message' => $render,
]);
$captured_emails = \Drupal::state()
->get('system.test_mail_collector');
$sent_message = end($captured_emails);
$expected_html = MailFormatHelper::wrapMail($expected_html);
$this
->assertSame($expected_html, $sent_message['body'], "Asserting that {$attribute} is properly converted for mails.");
}
foreach ([
'href',
'src',
] as $attribute) {
\Drupal::state()
->set('system.test_mail_collector', []);
$html = "<{$tag_name} {$attribute}=\"http://example.com/absolute\">absolute url in mail test</{$tag_name}>";
$expected_html = "<{$tag_name} {$attribute}=\"http://example.com/absolute\">absolute url in mail test</{$tag_name}>";
$render = [
'#markup' => Markup::create($html),
];
\Drupal::service('plugin.manager.mail')
->mail('mail_html_test', 'render_from_message_param', 'relative_url@example.com', $language_interface
->getId(), [
'message' => $render,
]);
$captured_emails = \Drupal::state()
->get('system.test_mail_collector');
$sent_message = end($captured_emails);
$expected_html = MailFormatHelper::wrapMail($expected_html);
$this
->assertSame($expected_html, $sent_message['body'], "Asserting that {$attribute} is properly converted for mails.");
}
}
public function testRenderedElementsUseAbsolutePaths() {
$language_interface = \Drupal::languageManager()
->getCurrentLanguage();
$this
->configureDefaultMailInterface('test_html_mail_collector');
$http_host = \Drupal::request()
->getSchemeAndHttpHost();
$random = new Random();
$image_name = $random
->name();
$test_base_url = 'http://localhost';
$this
->setSetting('file_public_base_url', $test_base_url);
$filepath = \Drupal::service('file_system')
->createFilename("{$image_name}.png", '');
$directory_uri = 'public://' . dirname($filepath);
\Drupal::service('file_system')
->prepareDirectory($directory_uri, FileSystemInterface::CREATE_DIRECTORY);
$file = File::create([
'uri' => "public://{$image_name}.png",
'filename' => "{$image_name}.png",
]);
$file
->save();
$base_path = base_path();
$path_pairs = [
'root relative' => [
$file
->getFileUri(),
"{$http_host}{$base_path}{$image_name}.png",
],
'protocol relative' => [
'//example.com/image.png',
'//example.com/image.png',
],
'absolute' => [
'http://example.com/image.png',
'http://example.com/image.png',
],
];
foreach ($path_pairs as $test_type => $paths) {
[
$input_path,
$expected_path,
] = $paths;
\Drupal::state()
->set('system.test_mail_collector', []);
$render = [
'#theme' => 'image',
'#uri' => $input_path,
];
$expected_html = "<img src=\"{$expected_path}\" alt=\"\" />";
\Drupal::service('plugin.manager.mail')
->mail('mail_html_test', 'render_from_message_param', 'relative_url@example.com', $language_interface
->getId(), [
'message' => $render,
]);
$captured_emails = \Drupal::state()
->get('system.test_mail_collector');
$sent_message = end($captured_emails);
$expected_html = MailFormatHelper::wrapMail($expected_html);
$this
->assertSame($expected_html, $sent_message['body'], "Asserting that {$test_type} paths are converted properly.");
}
$path_pairs = [
'root relative' => [
Url::fromUserInput('/path/to/something'),
"{$http_host}{$base_path}path/to/something",
],
'protocol relative' => [
Url::fromUri('//example.com/image.png'),
'//example.com/image.png',
],
'absolute' => [
Url::fromUri('http://example.com/image.png'),
'http://example.com/image.png',
],
];
foreach ($path_pairs as $paths) {
[
$input_path,
$expected_path,
] = $paths;
\Drupal::state()
->set('system.test_mail_collector', []);
$render = [
'#title' => 'Link',
'#type' => 'link',
'#url' => $input_path,
];
$expected_html = "<a href=\"{$expected_path}\">Link</a>";
\Drupal::service('plugin.manager.mail')
->mail('mail_html_test', 'render_from_message_param', 'relative_url@example.com', $language_interface
->getId(), [
'message' => $render,
]);
$captured_emails = \Drupal::state()
->get('system.test_mail_collector');
$sent_message = end($captured_emails);
$expected_html = MailFormatHelper::wrapMail($expected_html);
$this
->assertSame($expected_html, $sent_message['body']);
}
}
protected function configureDefaultMailInterface($mail_interface) {
$GLOBALS['config']['system.mail']['interface']['default'] = $mail_interface;
}
}