Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. MetadataHeader.php

class MetadataHeader

@author Kevin Bond <kevinbond@gmail.com>

Hierarchy

  • class \Symfony\Component\Mime\Header\AbstractHeader implements \Symfony\Component\Mime\Header\HeaderInterface
    • class \Symfony\Component\Mime\Header\UnstructuredHeader extends \Symfony\Component\Mime\Header\AbstractHeader
      • class \Symfony\Component\Mailer\Header\MetadataHeader extends \Symfony\Component\Mime\Header\UnstructuredHeader

Expanded class hierarchy of MetadataHeader

File

vendor/symfony/mailer/Header/MetadataHeader.php, line 19

Namespace

Symfony\Component\Mailer\Header
View source
final class MetadataHeader extends UnstructuredHeader {
    public function __construct(string $key, string $value) {
        parent::__construct('X-Metadata-' . $key, $value);
    }
    public function getKey() : string {
        return $this->key;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
AbstractHeader::$charset private property
AbstractHeader::$encoder private static property 1
AbstractHeader::$lang private property
AbstractHeader::$lineLength private property
AbstractHeader::$name private property
AbstractHeader::createPhrase protected function Produces a compliant, formatted RFC 2822 &#039;phrase&#039; based on the string given.
AbstractHeader::encodeWords protected function Encode needed word tokens within a string of input.
AbstractHeader::generateTokenLines protected function Generates tokens from the given string which include CRLF as individual tokens.
AbstractHeader::getCharset public function Overrides HeaderInterface::getCharset
AbstractHeader::getEncodableWordTokens protected function Splits a string into tokens in blocks of words which can be encoded quickly.
AbstractHeader::getLanguage public function Overrides HeaderInterface::getLanguage
AbstractHeader::getMaxLineLength public function Overrides HeaderInterface::getMaxLineLength
AbstractHeader::getName public function Overrides HeaderInterface::getName
AbstractHeader::getTokenAsEncodedWord protected function Get a token as an encoded word for safe insertion into headers.
AbstractHeader::PHRASE_PATTERN public constant
AbstractHeader::setCharset public function Overrides HeaderInterface::setCharset
AbstractHeader::setLanguage public function Set the language used in this Header. Overrides HeaderInterface::setLanguage
AbstractHeader::setMaxLineLength public function Overrides HeaderInterface::setMaxLineLength
AbstractHeader::tokenNeedsEncoding protected function 2
AbstractHeader::tokensToString private function Takes an array of tokens which appear in the header and turns them into
an RFC 2822 compliant string, adding FWSP where needed.
AbstractHeader::toString public function Gets this Header rendered as a compliant string. Overrides HeaderInterface::toString
AbstractHeader::toTokens protected function Generate a list of all tokens in the final header. 1
MetadataHeader::getKey public function
MetadataHeader::__construct public function Overrides UnstructuredHeader::__construct
UnstructuredHeader::$value private property
UnstructuredHeader::getBody public function Gets the body. Overrides HeaderInterface::getBody
UnstructuredHeader::getBodyAsString public function Get the value of this header prepared for rendering. Overrides HeaderInterface::getBodyAsString 1
UnstructuredHeader::getValue public function Get the (unencoded) value of this header.
UnstructuredHeader::setBody public function Overrides HeaderInterface::setBody
UnstructuredHeader::setValue public function Set the (unencoded) value of this header.

API Navigation

  • Drupal Core 11.1.x
  • Topics
  • Classes
  • Functions
  • Constants
  • Globals
  • Files
  • Namespaces
  • Deprecated
  • Services
RSS feed
Powered by Drupal