public function EmailExampleGetFormPage::submitForm in Examples for Developers 8

Same name and namespace in other branches

1. 3.x modules/email_example/src/Form/EmailExampleGetFormPage.php \Drupal\email_example\Form\EmailExampleGetFormPage::submitForm()

Form submission handler.

Parameters

array $form: An associative array containing the structure of the form.

\Drupal\Core\Form\FormStateInterface $form_state: The current state of the form.

Overrides FormInterface::submitForm

File

email_example/src/Form/EmailExampleGetFormPage.php, line 113

Class

EmailExampleGetFormPage

File test form class.

Namespace

Drupal\email_example\Form

Code

public function submitForm(array &$form, FormStateInterface $form_state) {
  $form_values = $form_state
    ->getValues();

  // All system mails need to specify the module and template key (mirrored
  // from hook_mail()) that the message they want to send comes from.
  $module = 'email_example';
  $key = 'contact_message';

  // Specify 'to' and 'from' addresses.
  $to = $form_values['email'];
  $from = $this
    ->config('system.site')
    ->get('mail');

  // "params" loads in additional context for email content completion in
  // hook_mail(). In this case, we want to pass in the values the user entered
  // into the form, which include the message body in $form_values['message'].
  $params = $form_values;

  // The language of the e-mail. This will one of three values:
  // - $account->getPreferredLangcode(): Used for sending mail to a particular
  //   website user, so that the mail appears in their preferred language.
  // - \Drupal::currentUser()->getPreferredLangcode(): Used when sending a
  //   mail back to the user currently viewing the site. This will send it in
  //   the language they're currently using.
  // - \Drupal::languageManager()->getDefaultLanguage()->getId: Used when
  //   sending mail to a pre-existing, 'neutral' address, such as the system
  //   e-mail address, or when you're unsure of the language preferences of
  //   the intended recipient.
  //
  // Since in our case, we are sending a message to a random e-mail address
  // that is not necessarily tied to a user account, we will use the site's
  // default language.
  $language_code = $this->languageManager
    ->getDefaultLanguage()
    ->getId();

  // Whether or not to automatically send the mail when we call mail() on the
  // mail manager. This defaults to TRUE, and is normally what you want unless
  // you need to do additional processing before the mail manager sends the
  // message.
  $send_now = TRUE;

  // Send the mail, and check for success. Note that this does not guarantee
  // message delivery; only that there were no PHP-related issues encountered
  // while sending.
  $result = $this->mailManager
    ->mail($module, $key, $to, $language_code, $params, $from, $send_now);
  if ($result['result'] == TRUE) {
    $this
      ->messenger()
      ->addMessage($this
      ->t('Your message has been sent.'));
  }
  else {
    $this
      ->messenger()
      ->addMessage($this
      ->t('There was a problem sending your message and it was not sent.'), 'error');
  }
}