class Mail

Same name in this branch
  1. 8.9.x core/lib/Drupal/Component/Utility/Mail.php \Drupal\Component\Utility\Mail
Same name 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. 10 core/lib/Drupal/Core/Mail/Attribute/Mail.php \Drupal\Core\Mail\Attribute\Mail
  4. 10 core/lib/Drupal/Core/Annotation/Mail.php \Drupal\Core\Annotation\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 annotation object.

Plugin Namespace: Plugin\Mail

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

Hierarchy

Expanded class hierarchy of Mail

See also

\Drupal\Core\Mail\MailInterface

\Drupal\Core\Mail\MailManager

Plugin API

Related topics

Annotations
Annotations for class discovery and metadata description.
54 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

4 classes are annotated with Mail
PhpMail in core/lib/Drupal/Core/Mail/Plugin/Mail/PhpMail.php
Defines the default Drupal mail backend, using PHP's native mail() function.
TestHtmlMailCollector in core/modules/system/tests/modules/mail_html_test/src/Plugin/Mail/TestHtmlMailCollector.php
Defines a mail backend that captures sent HTML messages in the state system.
TestMailCollector in core/lib/Drupal/Core/Mail/Plugin/Mail/TestMailCollector.php
Defines a mail backend that captures sent messages in the state system.
TestPhpMailFailure in core/modules/system/tests/modules/system_mail_failure_test/src/Plugin/Mail/TestPhpMailFailure.php
Defines a mail sending implementation that always fails.

File

core/lib/Drupal/Core/Annotation/Mail.php, line 20

Namespace

Drupal\Core\Annotation
View source 
class Mail extends Plugin {
    
    /**
     * The plugin ID.
     *
     * @var string
     */
    public $id;
    
    /**
     * The human-readable name of the mail plugin.
     *
     * @var \Drupal\Core\Annotation\Translation
     *
     * @ingroup plugin_translatable
     */
    public $label;
    
    /**
     * A short description of the mail plugin.
     *
     * @var \Drupal\Core\Annotation\Translation
     *
     * @ingroup plugin_translatable
     */
    public $description;

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
Mail::$description public property A short description of the mail plugin.
Mail::$id public property The plugin ID.
Mail::$label public property The human-readable name of the mail plugin.
Plugin::$definition protected property The plugin definition read from the class annotation. 1
Plugin::get public function Gets the value of an annotation. Overrides AnnotationInterface::get 5
Plugin::getClass public function Gets the class of the annotated class. Overrides AnnotationInterface::getClass
Plugin::getId public function Gets the unique ID for this annotated class. Overrides AnnotationInterface::getId
Plugin::getProvider public function Gets the name of the provider of the annotated class. Overrides AnnotationInterface::getProvider 1
Plugin::parse protected function Parses an annotation into its definition.
Plugin::setClass public function Sets the class of the annotated class. Overrides AnnotationInterface::setClass
Plugin::setProvider public function Sets the name of the provider of the annotated class. Overrides AnnotationInterface::setProvider
Plugin::__construct public function Constructs a Plugin object. 2

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