You are here

Home » API reference » Webform 8.5

WebformHandlerEmailAdvancedTest.php in Webform 8.5

Same filename and directory in other branches
  1. 6.x tests/src/Functional/Handler/WebformHandlerEmailAdvancedTest.php

Namespace

Drupal\Tests\webform\Functional\Handler

File

tests/src/Functional/Handler/WebformHandlerEmailAdvancedTest.php
View source 
<?php

namespace Drupal\Tests\webform\Functional\Handler;

use Drupal\webform\Entity\Webform;
use Drupal\Tests\webform\Functional\WebformBrowserTestBase;

/**
 * Tests for advanced email webform handler functionality with HTML and attachments.
 *
 * @group webform
 */
class WebformHandlerEmailAdvancedTest extends WebformBrowserTestBase {
  public static $modules = [
    'filter',
    'file',
    'webform',
  ];

  /**
   * Webforms to load.
   *
   * @var array
   */
  protected static $testWebforms = [
    'test_handler_email_advanced',
  ];

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();

    // Create filter.
    $this
      ->createFilters();
  }

  /**
   * Test advanced email handler.
   *
   * Note:
   * The TestMailCollector extends PhpMail, therefore the HTML body
   * will still be escaped, which is why we are looking at the params.body.
   *
   * @see \Drupal\Core\Mail\Plugin\Mail\TestMailCollector
   */
  public function testAdvancedEmailHandler() {
    global $base_url;

    /** @var \Drupal\webform\WebformInterface $webform */
    $webform = Webform::load('test_handler_email_advanced');

    /**************************************************************************/

    // Generate a test submission with a file upload.
    $this
      ->drupalLogin($this->rootUser);

    // Check handler's custom reply to and return path.
    $this
      ->postSubmissionTest($webform);
    $sent_email = $this
      ->getLastEmail();
    $this
      ->assertEqual($sent_email['headers']['Return-Path'], 'return_path@example.com');
    $this
      ->assertEqual($sent_email['headers']['Sender'], 'sender_name <sender_mail@example.com>');
    $this
      ->assertEqual($sent_email['headers']['Reply-to'], 'reply_to@example.com');
    $this
      ->assertEqual($sent_email['params']['custom_parameter'], 'test');
    $this
      ->assertArrayNotHasKey('parameters', $sent_email['params']);
    $webform
      ->getHandler('email')
      ->setSettings([
      'reply_to' => '',
      'return_path' => '',
      'sender_mail' => '',
      'sender_name' => '',
    ]);
    $webform
      ->save();

    // Check no custom reply to and return path.
    $this
      ->postSubmissionTest($webform);
    $sent_email = $this
      ->getLastEmail();
    $this
      ->assertNotEqual($sent_email['headers']['Return-Path'], 'return_path@example.com');
    $this
      ->assertNotEqual($sent_email['headers']['Sender'], 'sender_name <sender_mail@example.com>');
    $this
      ->assertNotEqual($sent_email['headers']['Reply-to'], 'reply_to@example.com');
    $this
      ->assertEqual($sent_email['headers']['Return-Path'], $sent_email['params']['from_mail']);
    $this
      ->assertEqual($sent_email['headers']['Sender'], $sent_email['params']['from_mail']);
    $this
      ->assertEqual($sent_email['headers']['Reply-to'], $sent_email['headers']['From']);

    // Check site wide reply to and return path.
    \Drupal::configFactory()
      ->getEditable('webform.settings')
      ->set('mail.default_reply_to', 'default_reply_to@example.com')
      ->set('mail.default_return_path', 'default_return_path@example.com')
      ->save();
    $this
      ->postSubmissionTest($webform);
    $sent_email = $this
      ->getLastEmail();
    $this
      ->assertEqual($sent_email['headers']['Return-Path'], 'default_return_path@example.com');
    $this
      ->assertEqual($sent_email['headers']['Sender'], 'default_return_path@example.com');
    $this
      ->assertEqual($sent_email['headers']['Reply-to'], 'default_reply_to@example.com');

    // Check site wide reply to and return path using tokens.
    \Drupal::configFactory()
      ->getEditable('system.site')
      ->set('mail', 'system_site@example.com')
      ->save();
    \Drupal::configFactory()
      ->getEditable('webform.settings')
      ->set('mail.default_reply_to', '[site:mail]')
      ->set('mail.default_return_path', '[site:mail]')
      ->save();
    $this
      ->postSubmissionTest($webform);
    $sent_email = $this
      ->getLastEmail();
    $this
      ->assertEqual($sent_email['headers']['Return-Path'], 'system_site@example.com');
    $this
      ->assertEqual($sent_email['headers']['Sender'], 'system_site@example.com');
    $this
      ->assertEqual($sent_email['headers']['Reply-to'], 'system_site@example.com');

    // Check site wide sender mail and name.
    \Drupal::configFactory()
      ->getEditable('webform.settings')
      ->set('mail.default_sender_mail', 'default_sender_mail@example.com')
      ->set('mail.default_sender_name', 'Default Sender Name')
      ->save();
    $this
      ->postSubmissionTest($webform);
    $sent_email = $this
      ->getLastEmail();
    $this
      ->assertEqual($sent_email['headers']['Sender'], 'Default Sender Name <default_sender_mail@example.com>');

    // Post a new submission using test webform which will automatically
    // upload file.txt.
    $edit = [
      'first_name' => 'John',
      'last_name' => 'Smith',
      'email' => 'from@example.com',
      // Drupal strip_tags() from mail subject.
      // @see \Drupal\Core\Mail\MailManager::doMail
      // @see http://cgit.drupalcode.org/drupal/tree/core/lib/Drupal/Core/Mail/MailManager.php#n285
      'subject' => 'This has <removed>"special" \'chararacters\'',
      'message[value]' => '<p><em>Please enter a message.</em> Test that double "quotes" are not encoded.</p>',
      'checkbox' => FALSE,
    ];
    $this
      ->postSubmissionTest($webform, $edit);
    $sid = $this
      ->getLastSubmissionId($webform);
    $sent_email = $this
      ->getLastEmail();

    // Check email subject with special characters.
    $this
      ->assertEqual($sent_email['subject'], 'This has "special" \'chararacters\'');

    // Check email body is HTML.
    $this
      ->assertStringContainsString('<b>First name</b><br />John<br /><br />', $sent_email['params']['body']);
    $this
      ->assertStringContainsString('<b>Last name</b><br />Smith<br /><br />', $sent_email['params']['body']);
    $this
      ->assertStringContainsString('<b>Email</b><br /><a href="mailto:from@example.com">from@example.com</a><br /><br />', $sent_email['params']['body']);
    $this
      ->assertStringContainsString('<b>Subject</b><br />This has &lt;removed&gt;&quot;special&quot; &#039;chararacters&#039;<br /><br />', $sent_email['params']['body']);
    $this
      ->assertStringContainsString('<b>Message</b><br /><p><em>Please enter a message.</em> Test that double "quotes" are not encoded.</p><br /><br />', $sent_email['params']['body']);
    $this
      ->assertStringContainsString('<p style="color:yellow"><em>Custom styled HTML markup</em></p>', $sent_email['params']['body']);
    $this
      ->assertStringContainsString('<b>File</b><br />', $sent_email['params']['body']);
    $this
      ->assertStringNotContainsString('<b>Optional</b><br />{Empty}<br /><br />', $sent_email['params']['body']);
    $this
      ->assertStringNotContainsString('<b>Checkbox/b><br />Yes<br /><br />', $sent_email['params']['body']);

    // Check email has attachment.
    $this
      ->assertEqual($sent_email['params']['attachments'][0]['filecontent'], "this is a sample txt file\nit has two lines\n");
    $this
      ->assertEqual($sent_email['params']['attachments'][0]['filename'], 'file.txt');
    $this
      ->assertEqual($sent_email['params']['attachments'][0]['filemime'], 'text/plain');

    // Check resend webform includes link to the attachment.
    $this
      ->drupalGet("admin/structure/webform/manage/test_handler_email_advanced/submission/{$sid}/resend");
    $this
      ->assertRaw('<strong><a href="' . $base_url . '/system/files/webform/test_handler_email_advanced/6/file.txt">file.txt</a></strong> (text/plain) - 43 bytes');

    // Check resend webform with custom message.
    $this
      ->drupalPostForm("admin/structure/webform/manage/test_handler_email_advanced/submission/{$sid}/resend", [
      'message[body][value]' => 'Testing 123…',
    ], 'Resend message');
    $sent_email = $this
      ->getLastEmail();
    $this
      ->assertStringNotContainsString('<b>First name</b><br />John<br /><br />', $sent_email['params']['body']);
    $this
      ->debug($sent_email['params']['body']);
    $this
      ->assertEqual($sent_email['params']['body'], 'Testing 123…');

    // Check resent email has the same attachment.
    $this
      ->assertEqual($sent_email['params']['attachments'][0]['filecontent'], "this is a sample txt file\nit has two lines\n");
    $this
      ->assertEqual($sent_email['params']['attachments'][0]['filename'], 'file.txt');
    $this
      ->assertEqual($sent_email['params']['attachments'][0]['filemime'], 'text/plain');
    $email_handler = $webform
      ->getHandler('email');

    // Exclude file attachment.
    $email_handler
      ->setSetting('exclude_attachments', TRUE);
    $webform
      ->save();

    // Check excluding attachments.
    $this
      ->postSubmissionTest($webform);
    $sent_email = $this
      ->getLastEmail();
    $this
      ->assertStringNotContainsString('<b>File</b><br />', $sent_email['params']['body']);
    $this
      ->assertArrayHasKey('filecontent', $sent_email['params']['attachments'][0]);

    // Exclude file element.
    $email_handler
      ->setSetting('excluded_elements', [
      'file' => 'file',
    ]);
    $webform
      ->save();

    // Check excluding files.
    $this
      ->postSubmissionTest($webform);
    $sent_email = $this
      ->getLastEmail();
    $this
      ->assertStringNotContainsString('<b>File</b><br />', $sent_email['params']['body']);
    $this
      ->assertFalse(isset($sent_email['params']['attachments'][0]['filecontent']));

    // Check empty element is excluded.
    $this
      ->postSubmission($webform);
    $sent_email = $this
      ->getLastEmail();
    $this
      ->assertStringNotContainsString('<b>Optional</b><br />{Empty}<br /><br />', $sent_email['params']['body']);

    // Include empty.
    $email_handler
      ->setSettings([
      'exclude_empty' => FALSE,
      'exclude_empty_checkbox' => FALSE,
    ]);
    $webform
      ->save();

    // Check empty included.
    $this
      ->postSubmission($webform);
    $sent_email = $this
      ->getLastEmail();
    $this
      ->assertStringContainsString('<b>Optional</b><br />{Empty}<br /><br />', $sent_email['params']['body']);
    $this
      ->assertStringContainsString('<b>Checkbox</b><br />No<br /><br />', $sent_email['params']['body']);

    // Logut and use anonymous user account.
    $this
      ->drupalLogout();

    // Check that private is include in email because 'ignore_access' is TRUE.
    $this
      ->postSubmission($webform);
    $sent_email = $this
      ->getLastEmail();
    $this
      ->assertStringContainsString('<b>Notes</b><br />These notes are private.<br /><br />', $sent_email['params']['body']);

    // Disable ignore_access.
    $webform
      ->getHandler('email')
      ->setSetting('ignore_access', FALSE);
    $webform
      ->save();

    // Check that private is excluded from email because 'ignore_access' is FALSE.
    $this
      ->postSubmission($webform);
    $sent_email = $this
      ->getLastEmail();
    $this
      ->assertStringNotContainsString('<b>Notes</b><br />These notes are private.<br /><br />', $sent_email['params']['body']);
  }

}

Classes

Namesort descending Description
WebformHandlerEmailAdvancedTest Tests for advanced email webform handler functionality with HTML and attachments.