You are here

Home » API reference » Drupal 10 » Email.php

class Email in Drupal 10

Same name in this branch
  1. 10 core/lib/Drupal/Core/Render/Element/Email.php \Drupal\Core\Render\Element\Email
  2. 10 core/lib/Drupal/Core/TypedData/Plugin/DataType/Email.php \Drupal\Core\TypedData\Plugin\DataType\Email
  3. 10 core/modules/field/src/Plugin/migrate/field/Email.php \Drupal\field\Plugin\migrate\field\Email
Same name and namespace in other branches
  1. 8 core/lib/Drupal/Core/Render/Element/Email.php \Drupal\Core\Render\Element\Email
  2. 9 core/lib/Drupal/Core/Render/Element/Email.php \Drupal\Core\Render\Element\Email

Provides a form input element for entering an email address.

Properties:

  • #default_value: An RFC-compliant email address.
  • #size: The size of the input element in characters.
  • #pattern: A string for the native HTML5 pattern attribute.

Example usage:

$form['email'] = [
  '#type' => 'email',
  '#title' => $this
    ->t('Email'),
  '#pattern' => '*@example.com',
];

Plugin annotation

@FormElement("email");

Hierarchy

Expanded class hierarchy of Email

See also

\Drupal\Core\Render\Element\Textfield

4 files declare their use of Email
EmailDefaultWidget.php in core/lib/Drupal/Core/Field/Plugin/Field/FieldWidget/EmailDefaultWidget.php
EmailItem.php in core/lib/Drupal/Core/Field/Plugin/Field/FieldType/EmailItem.php
UserPasswordForm.php in core/modules/user/src/Form/UserPasswordForm.php
UserValidationTest.php in core/modules/user/tests/src/Kernel/UserValidationTest.php
25 string references to 'Email'
AssertMailTrait::assertMail in core/lib/Drupal/Core/Test/AssertMailTrait.php
Asserts that the most recently sent email message has the given value.
Comment::baseFieldDefinitions in core/modules/comment/src/Entity/Comment.php
CommentForm::form in core/modules/comment/src/CommentForm.php
Gets the actual form array to be built.
ConstraintManager::registerDefinitions in core/lib/Drupal/Core/Validation/ConstraintManager.php
Callback for registering definitions for constraints shipped with Symfony.
contact_entity_extra_field_info in core/modules/contact/contact.module
Implements hook_entity_extra_field_info().

... See full list

10 #type uses of Email
AccountForm::form in core/modules/user/src/AccountForm.php
Gets the actual form array to be built.
AccountSettingsForm::buildForm in core/modules/user/src/AccountSettingsForm.php
Form constructor.
CommentForm::form in core/modules/comment/src/CommentForm.php
Gets the actual form array to be built.
EmailDefaultWidget::formElement in core/lib/Drupal/Core/Field/Plugin/Field/FieldWidget/EmailDefaultWidget.php
Returns the form for a single field widget.
FormTestDisabledElementsForm::buildForm in core/modules/system/tests/modules/form_test/src/Form/FormTestDisabledElementsForm.php
Form constructor.

... See full list

File

core/lib/Drupal/Core/Render/Element/Email.php, line 29

Namespace

Drupal\Core\Render\Element
View source 
class Email extends FormElement {

  /**
   * Defines the max length for an email address.
   *
   * The maximum length of an email address is 254 characters. RFC 3696
   * specifies a total length of 320 characters, but mentions that
   * addresses longer than 256 characters are not normally useful. Erratum
   * 1690 was then released which corrected this value to 254 characters.
   * @see http://tools.ietf.org/html/rfc3696#section-3
   * @see http://www.rfc-editor.org/errata_search.php?rfc=3696&eid=1690
   */
  const EMAIL_MAX_LENGTH = 254;

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $class = static::class;
    return [
      '#input' => TRUE,
      '#size' => 60,
      '#maxlength' => self::EMAIL_MAX_LENGTH,
      '#autocomplete_route_name' => FALSE,
      '#process' => [
        [
          $class,
          'processAutocomplete',
        ],
        [
          $class,
          'processAjaxForm',
        ],
        [
          $class,
          'processPattern',
        ],
      ],
      '#element_validate' => [
        [
          $class,
          'validateEmail',
        ],
      ],
      '#pre_render' => [
        [
          $class,
          'preRenderEmail',
        ],
      ],
      '#theme' => 'input__email',
      '#theme_wrappers' => [
        'form_element',
      ],
    ];
  }

  /**
   * Form element validation handler for #type 'email'.
   *
   * Note that #maxlength and #required is validated by _form_validate() already.
   */
  public static function validateEmail(&$element, FormStateInterface $form_state, &$complete_form) {
    $value = trim($element['#value']);
    $form_state
      ->setValueForElement($element, $value);
    if ($value !== '' && !\Drupal::service('email.validator')
      ->isValid($value)) {
      $form_state
        ->setError($element, t('The email address %mail is not valid.', [
        '%mail' => $value,
      ]));
    }
  }

  /**
   * Prepares a #type 'email' render element for input.html.twig.
   *
   * @param array $element
   *   An associative array containing the properties of the element.
   *   Properties used: #title, #value, #description, #size, #maxlength,
   *   #placeholder, #required, #attributes.
   *
   * @return array
   *   The $element with prepared variables ready for input.html.twig.
   */
  public static function preRenderEmail($element) {
    $element['#attributes']['type'] = 'email';
    Element::setAttributes($element, [
      'id',
      'name',
      'value',
      'size',
      'maxlength',
      'placeholder',
    ]);
    static::setAttributes($element, [
      'form-email',
    ]);
    return $element;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
Email::EMAIL_MAX_LENGTH constant Defines the max length for an email address.
Email::getInfo public function Returns the element properties for this element. Overrides ElementInterface::getInfo
Email::preRenderEmail public static function Prepares a #type 'email' render element for input.html.twig.
Email::validateEmail public static function Form element validation handler for #type 'email'.
FormElement::processAutocomplete public static function Adds autocomplete functionality to elements.
FormElement::processPattern public static function #process callback for #pattern form element property.
FormElement::validatePattern public static function #element_validate callback for #pattern form element property.
FormElement::valueCallback public static function Determines how user input is mapped to an element's #value property. Overrides FormElementInterface::valueCallback 15
MessengerTrait::$messenger protected property The messenger. 18
MessengerTrait::messenger public function Gets the messenger. 18
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition.
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function
PluginBase::getDerivativeId public function
PluginBase::getPluginDefinition public function 2
PluginBase::getPluginId public function
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. 53
RenderElement::preRenderAjaxForm public static function Adds Ajax information about an element to communicate with JavaScript.
RenderElement::preRenderGroup public static function Adds members of this group as actual elements for rendering.
RenderElement::processAjaxForm public static function Form element processing handler for the #ajax form property. 1
RenderElement::processGroup public static function Arranges elements into groups.
RenderElement::setAttributes public static function Sets a form element's class attribute. Overrides ElementInterface::setAttributes
StringTranslationTrait::$stringTranslation protected property The string translation service. 3
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 1
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.