function DevelMailLogTest::testDevelMailLogOutput
Same name in other branches
- 8.x-1.x tests/src/Kernel/DevelMailLogTest.php \Drupal\Tests\devel\Kernel\DevelMailLogTest::testDevelMailLogOutput()
- 4.x tests/src/Kernel/DevelMailLogTest.php \Drupal\Tests\devel\Kernel\DevelMailLogTest::testDevelMailLogOutput()
Tests devel mail log output.
File
-
tests/
src/ Kernel/ DevelMailLogTest.php, line 95
Class
- DevelMailLogTest
- Tests sending mails with debug interface.
Namespace
Drupal\Tests\devel\KernelCode
public function testDevelMailLogOutput() : void {
$config = \Drupal::config('devel.settings');
/** @var \Drupal\Core\Language\LanguageManagerInterface $language_manager */
$language_manager = $this->container
->get('language_manager');
// Parameters used for send the email.
$mail = [
'module' => 'devel_test',
'key' => 'devel_mail_log',
'to' => 'drupal@example.com',
'reply' => 'replyto@example.com',
'lang' => $language_manager->getCurrentLanguage()
->getId(),
];
// Parameters used for compose the email in devel_test module.
// @see devel_test_mail()
$params = [
'subject' => 'Devel mail log subject',
'body' => 'Devel mail log body',
'headers' => [
'from' => 'postmaster@example.com',
'additional' => [
'X-stupid' => 'dumb',
],
],
];
// Configure devel_mail_log as default mail backends.
$this->setDevelMailLogAsDefaultBackend();
// Changes the default filename pattern removing the dynamic date
// placeholder for a more predictable filename output.
$random = $this->randomMachineName();
$filename_pattern = '%to-%subject-' . $random . '.mail.txt';
$this->config('devel.settings')
->set('debug_mail_file_format', $filename_pattern)
->save();
$expected_filename = 'drupal@example.com-Devel_mail_log_subject-' . $random . '.mail.txt';
$expected_output = <<<EOF
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8; format=flowed; delsp=yes
Content-Transfer-Encoding: 8Bit
X-Mailer: Drupal
Return-Path: devel-test@example.com
Sender: devel-test@example.com
From: postmaster@example.com
Reply-to: replyto@example.com
X-stupid: dumb
To: drupal@example.com
Subject: Devel mail log subject
Devel mail log body
EOF;
// Ensures that the mail is captured by devel_mail_log and the placeholders
// in the filename are properly resolved.
$default_output_directory = $config->get('debug_mail_directory');
$expected_file_path = $default_output_directory . '/' . $expected_filename;
$this->mailManager
->mail($mail['module'], $mail['key'], $mail['to'], $mail['lang'], $params, $mail['reply']);
$this->assertFileExists($expected_file_path);
$this->assertStringEqualsFile($expected_file_path, $expected_output);
// Ensures that even changing the default output directory devel_mail_log
// works as expected.
$changed_output_directory = 'temporary://my-folder';
$expected_file_path = $changed_output_directory . '/' . $expected_filename;
$this->config('devel.settings')
->set('debug_mail_directory', $changed_output_directory)
->save();
$result = $this->mailManager
->mail($mail['module'], $mail['key'], $mail['to'], $mail['lang'], $params, $mail['reply']);
$this->assertTrue($result['result']);
$this->assertFileExists($expected_file_path);
$this->assertStringEqualsFile($expected_file_path, $expected_output);
// Ensures that if the default output directory is a public directory it
// will be protected by adding an .htaccess.
$public_output_directory = 'public://my-folder';
$expected_file_path = $public_output_directory . '/' . $expected_filename;
$this->config('devel.settings')
->set('debug_mail_directory', $public_output_directory)
->save();
$this->mailManager
->mail($mail['module'], $mail['key'], $mail['to'], $mail['lang'], $params, $mail['reply']);
$this->assertFileExists($expected_file_path);
$this->assertStringEqualsFile($expected_file_path, $expected_output);
$this->assertFileExists($public_output_directory . '/.htaccess');
}