class Mail

Same name in this branch
  1. 10 core/lib/Drupal/Core/Annotation/Mail.php \Drupal\Core\Annotation\Mail
Same name and namespace in other branches
  1. 9 core/lib/Drupal/Core/Annotation/Mail.php \Drupal\Core\Annotation\Mail
  2. 9 core/lib/Drupal/Component/Utility/Mail.php \Drupal\Component\Utility\Mail
  3. 8.9.x core/lib/Drupal/Core/Annotation/Mail.php \Drupal\Core\Annotation\Mail
  4. 8.9.x core/lib/Drupal/Component/Utility/Mail.php \Drupal\Component\Utility\Mail
  5. 11.x core/lib/Drupal/Core/Mail/Attribute/Mail.php \Drupal\Core\Mail\Attribute\Mail
  6. 11.x core/lib/Drupal/Core/Annotation/Mail.php \Drupal\Core\Annotation\Mail

Defines a Mail attribute for plugin discovery.

Plugin Namespace: Plugin\Mail

For a working example, see \Drupal\Core\Mail\Plugin\Mail\PhpMail

Hierarchy

  • class \Drupal\Core\Mail\Attribute\Mail implements \Drupal\Component\Plugin\Attribute\Plugin

Expanded class hierarchy of Mail

See also

\Drupal\Core\Mail\MailInterface

\Drupal\Core\Mail\MailManager

Plugin API

6 files declare their use of Mail
MailManager.php in core/lib/Drupal/Core/Mail/MailManager.php
PhpMail.php in core/lib/Drupal/Core/Mail/Plugin/Mail/PhpMail.php
SymfonyMailer.php in core/lib/Drupal/Core/Mail/Plugin/Mail/SymfonyMailer.php
TestHtmlMailCollector.php in core/modules/system/tests/modules/mail_html_test/src/Plugin/Mail/TestHtmlMailCollector.php
TestMailCollector.php in core/lib/Drupal/Core/Mail/Plugin/Mail/TestMailCollector.php

... See full list

59 string references to 'Mail'
AccountForm::flagViolations in core/modules/user/src/AccountForm.php
Flags violations for the current form.
AccountForm::form in core/modules/user/src/AccountForm.php
Gets the actual form array to be built.
AccountForm::getEditedFieldNames in core/modules/user/src/AccountForm.php
Gets the names of all fields edited in the form.
AccountSettingsForm::buildForm in core/modules/user/src/AccountSettingsForm.php
Form constructor.
ArbitraryRebuildTest::testUserRegistrationMultipleField in core/modules/system/tests/src/Functional/Form/ArbitraryRebuildTest.php
Tests a rebuild caused by a multiple value field.

... See full list

File

core/lib/Drupal/Core/Mail/Attribute/Mail.php, line 21

Namespace

Drupal\Core\Mail\Attribute
View on git.drupalcode.org
View source 
class Mail extends Plugin {
  
  /**
   * Constructs a Mail attribute.
   *
   * @param string $id
   *   The plugin ID.
   * @param \Drupal\Core\StringTranslation\TranslatableMarkup $label
   *   The label of the plugin.
   * @param \Drupal\Core\StringTranslation\TranslatableMarkup|null $description
   *   (optional) A description of the plugin.
   * @param class-string|null $deriver
   *   (optional) The deriver class.
   */
  public function __construct(public readonly string $id, public readonly TranslatableMarkup $label, public readonly ?TranslatableMarkup $description = NULL, public readonly ?string $deriver = NULL) {
  }

}

Members

Title Modifiers Object type Summary
Mail::__construct public function Constructs a Mail attribute.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.