class TestMailForm in Sparkpost email 8.2
Same name and namespace in other branches
- 8 src/Form/TestMailForm.php \Drupal\sparkpost\Form\TestMailForm
The form for sending test mails from Sparkpost.
@package Drupal\sparkpost\Form
Hierarchy
- class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\sparkpost\Form\TestMailForm
Expanded class hierarchy of TestMailForm
1 string reference to 'TestMailForm'
File
- src/
Form/ TestMailForm.php, line 20
Namespace
Drupal\sparkpost\FormView 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
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
FormBase:: |
protected | property | The config factory. | 1 |
FormBase:: |
protected | property | The request stack. | 1 |
FormBase:: |
protected | property | The route match. | |
FormBase:: |
protected | function | Retrieves a configuration object. | |
FormBase:: |
protected | function | Gets the config factory for this form. | 1 |
FormBase:: |
private | function | Returns the service container. | |
FormBase:: |
protected | function | Gets the current user. | |
FormBase:: |
protected | function | Gets the request object. | |
FormBase:: |
protected | function | Gets the route match. | |
FormBase:: |
protected | function | Gets the logger for a specific channel. | |
FormBase:: |
protected | function |
Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait:: |
|
FormBase:: |
public | function | Resets the configuration factory. | |
FormBase:: |
public | function | Sets the config factory for this form. | |
FormBase:: |
public | function | Sets the request stack object to use. | |
FormBase:: |
public | function |
Form validation handler. Overrides FormInterface:: |
62 |
LinkGeneratorTrait:: |
protected | property | The link generator. | 1 |
LinkGeneratorTrait:: |
protected | function | Returns the link generator. | |
LinkGeneratorTrait:: |
protected | function | Renders a link to a route given a route name and its parameters. | |
LinkGeneratorTrait:: |
public | function | Sets the link generator service. | |
LoggerChannelTrait:: |
protected | property | The logger channel factory service. | |
LoggerChannelTrait:: |
protected | function | Gets the logger for a specific channel. | |
LoggerChannelTrait:: |
public | function | Injects the logger channel factory. | |
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
RedirectDestinationTrait:: |
protected | property | The redirect destination service. | 1 |
RedirectDestinationTrait:: |
protected | function | Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url. | |
RedirectDestinationTrait:: |
protected | function | Returns the redirect destination service. | |
RedirectDestinationTrait:: |
public | function | Sets the redirect destination service. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. | |
TestMailForm:: |
protected | property | Drupal\Core\Mail\MailManagerInterface definition. | |
TestMailForm:: |
protected | property | Drupal\sparkpost\ClientService definition. | |
TestMailForm:: |
public | function | Access handler for the form. | |
TestMailForm:: |
public | function |
Form constructor. Overrides FormInterface:: |
|
TestMailForm:: |
public static | function |
Instantiates a new instance of this class. Overrides FormBase:: |
|
TestMailForm:: |
public | function |
Returns a unique string identifying the form. Overrides FormInterface:: |
|
TestMailForm:: |
public | function |
Form submission handler. Overrides FormInterface:: |
|
TestMailForm:: |
public | function | ||
UrlGeneratorTrait:: |
protected | property | The url generator. | |
UrlGeneratorTrait:: |
protected | function | Returns the URL generator service. | |
UrlGeneratorTrait:: |
public | function | Sets the URL generator service. | |
UrlGeneratorTrait:: |
protected | function | Generates a URL or path for a specific route based on the given parameters. |