function MailCaptureTest::testMailSend

Test to see if the wrapper function is executed correctly.

File

drupal/core/modules/simpletest/lib/Drupal/simpletest/Tests/MailCaptureTest.php, line 27

Definition of Drupal\simpletest\Tests\MailCaptureTest.

Class

MailCaptureTest

Namespace

Code

function testMailSend() {

  // Create an e-mail.
  $subject = $this
    ->randomString(64);
  $body = $this
    ->randomString(128);
  $message = array(
    'id' => 'drupal_mail_test',
    'headers' => array(
      'Content-type' => 'text/html',
    ),
    'subject' => $subject,
    'to' => 'foobar@example.com',
    'body' => $body,
  );

  // Before we send the e-mail, drupalGetMails should return an empty array.
  $captured_emails = $this
    ->drupalGetMails();
  $this
    ->assertEqual(count($captured_emails), 0, t('The captured e-mails queue is empty.'), t('E-mail'));

  // Send the e-mail.
  $response = drupal_mail_system('simpletest', 'drupal_mail_test')
    ->mail($message);

  // Ensure that there is one e-mail in the captured e-mails array.
  $captured_emails = $this
    ->drupalGetMails();
  $this
    ->assertEqual(count($captured_emails), 1, t('One e-mail was captured.'), t('E-mail'));

  // Assert that the e-mail was sent by iterating over the message properties
  // and ensuring that they are captured intact.
  foreach ($message as $field => $value) {
    $this
      ->assertMail($field, $value, t('The e-mail was sent and the value for property @field is intact.', array(
      '@field' => $field,
    )), t('E-mail'));
  }

  // Send additional e-mails so more than one e-mail is captured.
  for ($index = 0; $index < 5; $index++) {
    $message = array(
      'id' => 'drupal_mail_test_' . $index,
      'headers' => array(
        'Content-type' => 'text/html',
      ),
      'subject' => $this
        ->randomString(64),
      'to' => $this
        ->randomName(32) . '@example.com',
      'body' => $this
        ->randomString(512),
    );
    drupal_mail_system('drupal_mail_test', $index)
      ->mail($message);
  }

  // There should now be 6 e-mails captured.
  $captured_emails = $this
    ->drupalGetMails();
  $this
    ->assertEqual(count($captured_emails), 6, t('All e-mails were captured.'), t('E-mail'));

  // Test different ways of getting filtered e-mails via drupalGetMails().
  $captured_emails = $this
    ->drupalGetMails(array(
    'id' => 'drupal_mail_test',
  ));
  $this
    ->assertEqual(count($captured_emails), 1, t('Only one e-mail is returned when filtering by id.'), t('E-mail'));
  $captured_emails = $this
    ->drupalGetMails(array(
    'id' => 'drupal_mail_test',
    'subject' => $subject,
  ));
  $this
    ->assertEqual(count($captured_emails), 1, t('Only one e-mail is returned when filtering by id and subject.'), t('E-mail'));
  $captured_emails = $this
    ->drupalGetMails(array(
    'id' => 'drupal_mail_test',
    'subject' => $subject,
    'from' => 'this_was_not_used@example.com',
  ));
  $this
    ->assertEqual(count($captured_emails), 0, t('No e-mails are returned when querying with an unused from address.'), t('E-mail'));

  // Send the last e-mail again, so we can confirm that the drupalGetMails-filter
  // correctly returns all e-mails with a given property/value.
  drupal_mail_system('drupal_mail_test', $index)
    ->mail($message);
  $captured_emails = $this
    ->drupalGetMails(array(
    'id' => 'drupal_mail_test_4',
  ));
  $this
    ->assertEqual(count($captured_emails), 2, t('All e-mails with the same id are returned when filtering by id.'), t('E-mail'));
}