Same name and namespace in other branches
  1. 8.9.x core/lib/Drupal/Core/Annotation/Mail.php \Drupal\Core\Annotation\Mail
  2. 9 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.
1 string reference to 'Mail'
core.data_types.schema.yml in core/config/schema/core.data_types.schema.yml
core/config/schema/core.data_types.schema.yml

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

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