class Mail in Drupal 10

Defines a Mail annotation object.

Plugin Namespace: Plugin\Mail

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

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\Core\Annotation\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

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

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	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	6
Plugin::getClass	public	function	Gets the class of the annotated class. Overrides AnnotationInterface::getClass	1
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	1
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.	3