You are here

class TestMailForm in Sparkpost email 8.2

Same name and namespace in other branches
  1. 8 src/Form/TestMailForm.php \Drupal\sparkpost\Form\TestMailForm

The form for sending test mails from Sparkpost.

@package Drupal\sparkpost\Form

Hierarchy

Expanded class hierarchy of TestMailForm

1 string reference to 'TestMailForm'
sparkpost.routing.yml in ./sparkpost.routing.yml
sparkpost.routing.yml

File

src/Form/TestMailForm.php, line 20

Namespace

Drupal\sparkpost\Form
View source
class TestMailForm extends FormBase {

  /**
   * Drupal\sparkpost\ClientService definition.
   *
   * @var \Drupal\sparkpost\ClientService
   */
  protected $sparkpostClient;

  /**
   * Drupal\Core\Mail\MailManagerInterface definition.
   *
   * @var \Drupal\Core\Mail\MailManagerInterface
   */
  protected $mailManager;

  /**
   * {@inheritdoc}
   */
  public function __construct(ClientService $sparkpostClient, MailManagerInterface $mailManager) {
    $this->sparkpostClient = $sparkpostClient;
    $this->mailManager = $mailManager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('sparkpost.client'), $container
      ->get('plugin.manager.mail'));
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'test_mail_form';
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form['recipient'] = [
      '#type' => 'email',
      '#title' => $this
        ->t('Recipient'),
      '#required' => TRUE,
      '#default_value' => $this
        ->configFactory()
        ->get('system.site')
        ->get('mail'),
    ];
    $form['subject'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Subject'),
      '#maxlength' => 255,
      '#default_value' => $this
        ->t('Drupal Sparkpost test email'),
    ];
    $form['body'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('Body'),
      '#default_value' => $this
        ->t('If you receive this message it means your site is capable of using Sparkpost to send email. This url is here to test click tracking: <a href=":link">link</a>', [
        ':link' => Url::fromUri('http://www.drupal.org/project/sparkpost')
          ->toString(),
      ]),
    ];
    $form['attachment'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Add attachment'),
      '#default_value' => TRUE,
    ];
    $form['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Send'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {

    // Prepare.
    $to = $form_state
      ->getValue('recipient');
    $params = [];
    $params['subject'] = $form_state
      ->getValue('subject');
    $params['body'] = $form_state
      ->getValue('body');
    $params['include_attachment'] = $form_state
      ->getValue('attachment');

    // Send.
    $message = $this->mailManager
      ->mail('sparkpost', 'test_mail_form', $to, LanguageInterface::LANGCODE_NOT_SPECIFIED, $params);
    if ($message['result']) {
      $this
        ->messenger()
        ->addStatus($this
        ->t('Sparkpost test email sent to %to.', [
        '%to' => $to,
      ]));
    }
    else {
      $form_state
        ->setRebuild();
    }
  }

  /**
   * Access handler for the form.
   *
   * Requires a user to set an api key.
   *
   * @return \Drupal\Core\Access\AccessResultInterface
   *   The result.
   */
  public function access(AccountInterface $account) {
    $config = \Drupal::config('sparkpost.settings');
    if ($config
      ->get('api_key')) {
      return AccessResult::allowedIfHasPermission($account, 'administer sparkpost');
    }
    return AccessResult::forbidden();
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
FormBase::$configFactory protected property The config factory. 1
FormBase::$requestStack protected property The request stack. 1
FormBase::$routeMatch protected property The route match.
FormBase::config protected function Retrieves a configuration object.
FormBase::configFactory protected function Gets the config factory for this form. 1
FormBase::container private function Returns the service container.
FormBase::currentUser protected function Gets the current user.
FormBase::getRequest protected function Gets the request object.
FormBase::getRouteMatch protected function Gets the route match.
FormBase::logger protected function Gets the logger for a specific channel.
FormBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
FormBase::resetConfigFactory public function Resets the configuration factory.
FormBase::setConfigFactory public function Sets the config factory for this form.
FormBase::setRequestStack public function Sets the request stack object to use.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 62
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
TestMailForm::$mailManager protected property Drupal\Core\Mail\MailManagerInterface definition.
TestMailForm::$sparkpostClient protected property Drupal\sparkpost\ClientService definition.
TestMailForm::access public function Access handler for the form.
TestMailForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
TestMailForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
TestMailForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
TestMailForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
TestMailForm::__construct public function
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.