public function SettingsForm::buildForm in Swift Mailer 8

Same name and namespace in other branches

1. 8.2 src/Form/SettingsForm.php \Drupal\swiftmailer\Form\SettingsForm::buildForm()

Form constructor.

Parameters

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

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

Return value

array The form structure.

Overrides ConfigFormBase::buildForm

File

src/Form/SettingsForm.php, line 36

Class

SettingsForm

Swift Mailer settings form.

Namespace

Drupal\swiftmailer\Form

Code

public function buildForm(array $form, FormStateInterface $form_state) {
  $form = parent::buildForm($form, $form_state);
  $config = $this
    ->config('swiftmailer.transport');

  // Submitted form values should be nested.
  $form['#tree'] = TRUE;

  // Display a page description.
  $form['description'] = [
    '#markup' => '<p>' . $this
      ->t('This page allows you to configure settings which determines how e-mail messages are sent.') . '</p>',
  ];
  $form['transport'] = [
    '#id' => 'transport',
    '#type' => 'details',
    '#title' => $this
      ->t('Transport types'),
    '#description' => $this
      ->t('Which transport type should Drupal use to send e-mails?'),
    '#open' => TRUE,
  ];

  // Display the currently configured transport type, or alternatively the
  // currently selected transport type if the user has chosen to configure
  // another transport type.
  $transport = $config
    ->get('transport');
  $transport = $form_state
    ->hasValue([
    'transport',
    'type',
  ]) ? $form_state
    ->getValue([
    'transport',
    'type',
  ]) : $transport;
  $form['transport']['type'] = [
    '#type' => 'radios',
    '#options' => [
      SWIFTMAILER_TRANSPORT_SMTP => $this
        ->t('SMTP'),
      SWIFTMAILER_TRANSPORT_SENDMAIL => $this
        ->t('Sendmail'),
      SWIFTMAILER_TRANSPORT_NATIVE => $this
        ->t('PHP'),
      SWIFTMAILER_TRANSPORT_SPOOL => $this
        ->t('Spool'),
    ],
    '#default_value' => $transport,
    '#ajax' => [
      'callback' => [
        $this,
        'ajaxCallback',
      ],
      'wrapper' => 'transport_configuration',
      'method' => 'replace',
      'effect' => 'fade',
    ],
    '#description' => $this
      ->t('Not sure which transport type to choose? The @documentation gives you a good overview of the various transport types.', [
      '@documentation' => Link::fromTextAndUrl((string) $this
        ->t('Swift Mailer documentation'), Url::fromUri('https://swiftmailer.symfony.com/docs/sending.html#transport-types'))
        ->toString(),
    ]),
  ];
  $form['transport']['configuration'] = [
    '#type' => 'item',
    '#id' => 'transport_configuration',
  ];
  $form['transport']['configuration'][SWIFTMAILER_TRANSPORT_SMTP] = [
    '#type' => 'item',
    '#access' => $form['transport']['type']['#default_value'] == SWIFTMAILER_TRANSPORT_SMTP,
  ];
  $form['transport']['configuration'][SWIFTMAILER_TRANSPORT_SMTP]['title'] = [
    '#markup' => '<h3>' . $this
      ->t('SMTP transport options') . '</h3>',
  ];
  $form['transport']['configuration'][SWIFTMAILER_TRANSPORT_SMTP]['description'] = [
    '#markup' => '<p>' . $this
      ->t('This transport type will send all e-mails using a SMTP
      server of your choice. You need to specify which SMTP server
      to use. Please refer to the @documentation for more details
      about this transport type.', [
      '@documentation' => Link::fromTextAndUrl($this
        ->t('Swift Mailer documentation'), Url::fromUri('https://swiftmailer.symfony.com/docs/sending.html#the-smtp-transport'))
        ->toString(),
    ]) . '</p>',
  ];
  $form['transport']['configuration'][SWIFTMAILER_TRANSPORT_SMTP]['server'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('SMTP server'),
    '#description' => $this
      ->t('The hostname or IP address at which the SMTP server can be reached.'),
    '#required' => TRUE,
    '#default_value' => $config
      ->get('smtp_host'),
  ];
  $form['transport']['configuration'][SWIFTMAILER_TRANSPORT_SMTP]['port'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Port'),
    '#description' => $this
      ->t('The port at which the SMTP server can be reached (defaults to 25)'),
    '#default_value' => $config
      ->get('smtp_port'),
    '#size' => 10,
  ];
  $form['transport']['configuration'][SWIFTMAILER_TRANSPORT_SMTP]['encryption'] = [
    '#type' => 'select',
    '#title' => $this
      ->t('Encryption'),
    '#options' => swiftmailer_get_encryption_options(),
    '#description' => $this
      ->t('The type of encryption which should be used (if any)'),
    '#default_value' => $config
      ->get('smtp_encryption'),
  ];
  $form['transport']['configuration'][SWIFTMAILER_TRANSPORT_SMTP]['credential_provider'] = array(
    '#type' => 'select',
    '#title' => $this
      ->t('Credential provider'),
    '#options' => [
      'swiftmailer' => 'Swift Mailer',
    ],
    '#default_value' => $config
      ->get('smtp_credential_provider'),
    '#ajax' => array(
      'callback' => array(
        $this,
        'ajaxCallback',
      ),
      'wrapper' => 'transport_configuration',
      'method' => 'replace',
      'effect' => 'fade',
    ),
  );
  $smtp_credential_provider = $form_state
    ->getValue([
    'transport',
    'configuration',
    SWIFTMAILER_TRANSPORT_SMTP,
    'credential_provider',
  ], $config
    ->get('smtp_credential_provider'));
  if (\Drupal::moduleHandler()
    ->moduleExists('key')) {
    $form['transport']['configuration'][SWIFTMAILER_TRANSPORT_SMTP]['credential_provider']['#options']['key'] = 'Key Module';

    /** @var \Drupal\key\Plugin\KeyPluginManager $key_type */
    $key_type = \Drupal::service('plugin.manager.key.key_type');
    if ($key_type
      ->hasDefinition('user_password')) {
      $form['transport']['configuration'][SWIFTMAILER_TRANSPORT_SMTP]['credential_provider']['#options']['multikey'] = 'Key Module (user/password)';
    }
  }
  if ($smtp_credential_provider === 'swiftmailer') {
    $form['transport']['configuration'][SWIFTMAILER_TRANSPORT_SMTP]['credentials']['swiftmailer']['username'] = array(
      '#type' => 'textfield',
      '#title' => $this
        ->t('Username'),
      '#description' => $this
        ->t('A username required by the SMTP server (leave blank if not required)'),
      '#default_value' => $config
        ->get('smtp_credentials.swiftmailer.username'),
      '#attributes' => array(
        'autocomplete' => 'off',
      ),
    );
    $form['transport']['configuration'][SWIFTMAILER_TRANSPORT_SMTP]['credentials']['swiftmailer']['password'] = array(
      '#type' => 'password',
      '#title' => $this
        ->t('Password'),
      '#description' => $this
        ->t('A password required by the SMTP server (leave blank if not required)'),
      '#default_value' => $config
        ->get('smtp_credentials.swiftmailer.password'),
      '#attributes' => array(
        'autocomplete' => 'off',
      ),
    );
    $current_password = $config
      ->get('smtp_credentials.swiftmailer.password');
    if (!empty($current_password)) {
      $form['transport']['configuration'][SWIFTMAILER_TRANSPORT_SMTP]['credentials']['swiftmailer']['password']['#description'] = $this
        ->t('A password required by the SMTP server. <em>The currently set password is hidden for security reasons</em>.');
    }
    $form['transport']['configuration'][SWIFTMAILER_TRANSPORT_SMTP]['credentials']['swiftmailer']['delete_password'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Delete the stored password'),
    );
  }
  elseif ($smtp_credential_provider === 'key') {
    $form['transport']['configuration'][SWIFTMAILER_TRANSPORT_SMTP]['credentials']['key']['username'] = array(
      '#type' => 'key_select',
      '#title' => $this
        ->t('Username'),
      '#description' => $this
        ->t('A username required by the SMTP server.'),
      '#default_value' => $config
        ->get('smtp_credentials.key.username'),
      '#empty_option' => $this
        ->t('- Please select -'),
      '#key_filters' => [
        'type' => 'authentication',
      ],
      '#required' => TRUE,
    );
    $form['transport']['configuration'][SWIFTMAILER_TRANSPORT_SMTP]['credentials']['key']['password'] = array(
      '#type' => 'key_select',
      '#title' => $this
        ->t('Password'),
      '#description' => $this
        ->t('A password required by the SMTP server.'),
      '#default_value' => $config
        ->get('smtp_credentials.key.password'),
      '#empty_option' => $this
        ->t('- Please select -'),
      '#key_filters' => [
        'type' => 'authentication',
      ],
      '#required' => TRUE,
    );
  }
  elseif ($smtp_credential_provider === 'multikey') {
    $form['transport']['configuration'][SWIFTMAILER_TRANSPORT_SMTP]['credentials']['multikey']['user_password'] = array(
      '#type' => 'key_select',
      '#title' => $this
        ->t('User/password'),
      '#description' => $this
        ->t('A username + password required by the SMTP server.'),
      '#default_value' => $config
        ->get('smtp_credentials.multikey.user_password'),
      '#empty_option' => $this
        ->t('- Please select -'),
      '#key_filters' => [
        'type' => 'user_password',
      ],
      '#required' => TRUE,
    );
  }
  $form['transport']['configuration'][SWIFTMAILER_TRANSPORT_SENDMAIL] = [
    '#type' => 'item',
    '#access' => $form['transport']['type']['#default_value'] == SWIFTMAILER_TRANSPORT_SENDMAIL,
  ];
  $form['transport']['configuration'][SWIFTMAILER_TRANSPORT_SENDMAIL]['title'] = [
    '#markup' => '<h3>' . $this
      ->t('Sendmail transport options') . '</h3>',
  ];
  $form['transport']['configuration'][SWIFTMAILER_TRANSPORT_SENDMAIL]['description'] = [
    '#markup' => '<p>' . $this
      ->t('This transport type will send all e-mails using a locally
      installed MTA such as Sendmail. You need to specify which
      locally installed MTA to use by providing a path to the
      MTA. If you do not provide any path then Swift Mailer
      defaults to /usr/sbin/sendmail. You can read more about
      this transport type in the @documentation.', [
      '@documentation' => Link::fromTextAndUrl($this
        ->t('Swift Mailer documentation'), Url::fromUri('https://swiftmailer.symfony.com/docs/sending.html#the-sendmail-transport'))
        ->toString(),
    ]) . '</p>',
  ];
  $form['transport']['configuration'][SWIFTMAILER_TRANSPORT_SENDMAIL]['path'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('MTA path'),
    '#description' => $this
      ->t('The absolute path to the locally installed MTA.'),
    '#default_value' => $config
      ->get('sendmail_path'),
  ];
  $form['transport']['configuration'][SWIFTMAILER_TRANSPORT_SENDMAIL]['mode'] = [
    '#type' => 'radios',
    '#title' => $this
      ->t('Mode'),
    '#options' => [
      'bs' => 'bs',
      't' => 't ',
    ],
    '#description' => $this
      ->t('Not sure which option to choose? Go with <em>bs</em>. You can read more about the above two modes in the @documentation.', [
      '@documentation' => Link::fromTextAndUrl($this
        ->t('Swift Mailer documentation'), Url::fromUri('https://swiftmailer.symfony.com/docs/sendmail-transport'))
        ->toString(),
    ]),
    '#default_value' => $config
      ->get('sendmail_mode'),
  ];
  $form['transport']['configuration'][SWIFTMAILER_TRANSPORT_NATIVE] = [
    '#type' => 'item',
    '#access' => $form['transport']['type']['#default_value'] == SWIFTMAILER_TRANSPORT_NATIVE,
  ];
  $form['transport']['configuration'][SWIFTMAILER_TRANSPORT_NATIVE]['title'] = [
    '#markup' => '<h3>' . $this
      ->t('PHP transport options') . '</h3>',
  ];
  $form['transport']['configuration'][SWIFTMAILER_TRANSPORT_NATIVE]['description'] = [
    '#markup' => '<p>' . $this
      ->t('This transport type will send all e-mails using the built-in
      mail functionality of PHP. This transport type can not be
      configured here. Please refer to the @documentation if you
      would like to read more about how the built-in mail functionality
      in PHP can be configured.', [
      '@documentation' => Link::fromTextAndUrl($this
        ->t('PHP documentation'), Url::fromUri('http://www.php.net/manual/en/mail.configuration.php'))
        ->toString(),
    ]) . '</p>',
  ];
  $form['transport']['configuration'][SWIFTMAILER_TRANSPORT_SPOOL] = [
    '#type' => 'item',
    '#access' => $form['transport']['type']['#default_value'] == SWIFTMAILER_TRANSPORT_SPOOL,
  ];
  $form['transport']['configuration'][SWIFTMAILER_TRANSPORT_SPOOL]['title'] = [
    '#markup' => '<h3>' . $this
      ->t('Spool transport options') . '</h3>',
  ];
  $form['transport']['configuration'][SWIFTMAILER_TRANSPORT_SPOOL]['description'] = [
    '#markup' => '<p>' . $this
      ->t('This transport does not attempt to send the email
    but instead saves the message to a spool file. Another process can then
    read from the spool and take care of sending the emails.') . '</p>',
  ];
  $spool_directory = $config
    ->get('spool_directory');
  $form['transport']['configuration'][SWIFTMAILER_TRANSPORT_SPOOL]['directory'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Spool directory'),
    '#description' => $this
      ->t('The absolute path to the spool directory.'),
    '#default_value' => !empty($spool_directory) ? $spool_directory : sys_get_temp_dir() . '/swiftmailer-spool',
  ];
  return $form;
}