Inheritance diagram for Symfony\Component\Mime\Header\AbstractHeader:

Public Member Functions
	__construct (string $name)

	getCharset ()

	getLanguage ()

	getMaxLineLength ()

	getName ()

	setCharset (string $charset)

	setLanguage (string $lang)

	setMaxLineLength (int $lineLength)

	toString ()

Public Member Functions inherited from Symfony\Component\Mime\Header\HeaderInterface
	getBody ()

	getBodyAsString ()

	setBody ($body)

Data Fields
const	PHRASE_PATTERN = '(?:(?:(?:(?:(?:(?:(?:[ \t](?:\r\n))?[ \t])?($(?:(?:(?:[ \t](?:\r\n))?[ \t])\|(?:(?:[\x01-\x08\x0B\x0C\x0E-\x19\x7F]\|[\x21-\x27\x2A-\x5B\x5D-\x7E])\|(?:\\[\x00-\x08\x0B\x0C\x0E-\x7F])\|(?1)))(?:(?:[ \t](?:\r\n))?[ \t])?$))(?:(?:(?:(?:[ \t](?:\r\n))?[ \t])?($(?:(?:(?:[ \t](?:\r\n))?[ \t])\|(?:(?:[\x01-\x08\x0B\x0C\x0E-\x19\x7F]\|[\x21-\x27\x2A-\x5B\x5D-\x7E])\|(?:\\[\x00-\x08\x0B\x0C\x0E-\x7F])\|(?1)))(?:(?:[ \t](?:\r\n))?[ \t])?$))\|(?:(?:[ \t](?:\r\n))?[ \t])))?[a-zA-Z0-9!#\$%&\'\\+\-\/=\?\^_`\{\}\\|~]+(?:(?:(?:(?:[ \t](?:\r\n))?[ \t])?($(?:(?:(?:[ \t](?:\r\n))?[ \t])\|(?:(?:[\x01-\x08\x0B\x0C\x0E-\x19\x7F]\|[\x21-\x27\x2A-\x5B\x5D-\x7E])\|(?:\\[\x00-\x08\x0B\x0C\x0E-\x7F])\|(?1)))(?:(?:[ \t](?:\r\n))?[ \t])?$))(?:(?:(?:(?:[ \t](?:\r\n))?[ \t])?($(?:(?:(?:[ \t](?:\r\n))?[ \t])\|(?:(?:[\x01-\x08\x0B\x0C\x0E-\x19\x7F]\|[\x21-\x27\x2A-\x5B\x5D-\x7E])\|(?:\\[\x00-\x08\x0B\x0C\x0E-\x7F])\|(?1)))(?:(?:[ \t](?:\r\n))?[ \t])?$))\|(?:(?:[ \t](?:\r\n))?[ \t])))?)\|(?:(?:(?:(?:(?:[ \t](?:\r\n))?[ \t])?($(?:(?:(?:[ \t](?:\r\n))?[ \t])\|(?:(?:[\x01-\x08\x0B\x0C\x0E-\x19\x7F]\|[\x21-\x27\x2A-\x5B\x5D-\x7E])\|(?:\\[\x00-\x08\x0B\x0C\x0E-\x7F])\|(?1)))(?:(?:[ \t](?:\r\n))?[ \t])?$))(?:(?:(?:(?:[ \t](?:\r\n))?[ \t])?($(?:(?:(?:[ \t](?:\r\n))?[ \t])\|(?:(?:[\x01-\x08\x0B\x0C\x0E-\x19\x7F]\|[\x21-\x27\x2A-\x5B\x5D-\x7E])\|(?:\\[\x00-\x08\x0B\x0C\x0E-\x7F])\|(?1)))(?:(?:[ \t](?:\r\n))?[ \t])?$))\|(?:(?:[ \t](?:\r\n))?[ \t])))?"((?:(?:[ \t](?:\r\n))?[ \t])?(?:(?:[\x01-\x08\x0B\x0C\x0E-\x19\x7F]\|[\x21\x23-\x5B\x5D-\x7E])\|(?:\\[\x00-\x08\x0B\x0C\x0E-\x7F])))(?:(?:[ \t](?:\r\n))?[ \t])?"(?:(?:(?:(?:[ \t](?:\r\n))?[ \t])?($(?:(?:(?:[ \t](?:\r\n))?[ \t])\|(?:(?:[\x01-\x08\x0B\x0C\x0E-\x19\x7F]\|[\x21-\x27\x2A-\x5B\x5D-\x7E])\|(?:\\[\x00-\x08\x0B\x0C\x0E-\x7F])\|(?1)))(?:(?:[ \t](?:\r\n))?[ \t])?$))(?:(?:(?:(?:[ \t](?:\r\n))?[ \t])?($(?:(?:(?:[ \t](?:\r\n))?[ \t])\|(?:(?:[\x01-\x08\x0B\x0C\x0E-\x19\x7F]\|[\x21-\x27\x2A-\x5B\x5D-\x7E])\|(?:\\[\x00-\x08\x0B\x0C\x0E-\x7F])\|(?1)))(?:(?:[ \t](?:\r\n))?[ \t])?$))\|(?:(?:[ \t](?:\r\n))?[ \t])))?))+?)'

Protected Member Functions
	createPhrase (HeaderInterface $header, string $string, string $charset, bool $shorten=false)

	encodeWords (HeaderInterface $header, string $input, int $usedLength=-1)

	generateTokenLines (string $token)

	getEncodableWordTokens (string $string)

	getTokenAsEncodedWord (string $token, int $firstLineOffset=0)

	tokenNeedsEncoding (string $token)

	toTokens (string $string=null)

Detailed Description

An abstract base MIME Header.

Author: Chris Corbyn

Definition at line 21 of file AbstractHeader.php.

Constructor & Destructor Documentation

◆ __construct()

Symfony\Component\Mime\Header\AbstractHeader::__construct ( string $name )

Definition at line 32 of file AbstractHeader.php.

Member Function Documentation

◆ createPhrase()

Symfony\Component\Mime\Header\AbstractHeader::createPhrase	(	HeaderInterface	$header,
		string	$string,
		string	$charset,
		bool	$shorten = `false`
	)

protected

Produces a compliant, formatted RFC 2822 'phrase' based on the string given.

Parameters

string	$string	as displayed
bool	$shorten	the first line to make remove for header name

Definition at line 88 of file AbstractHeader.php.

References Symfony\Component\Mime\Header\AbstractHeader\encodeWords(), and Symfony\Component\Mime\Header\HeaderInterface\getName().

Referenced by Symfony\Component\Mime\Header\MailboxListHeader\getAddressStrings(), and Symfony\Component\Mime\Header\MailboxHeader\getBodyAsString().

◆ encodeWords()

Symfony\Component\Mime\Header\AbstractHeader::encodeWords	(	HeaderInterface	$header,
		string	$input,
		int	$usedLength = `-1`
	)

protected

Encode needed word tokens within a string of input.

Definition at line 120 of file AbstractHeader.php.

References Symfony\Component\Mime\Header\AbstractHeader\getEncodableWordTokens(), Symfony\Component\Mime\Header\HeaderInterface\getName(), Symfony\Component\Mime\Header\AbstractHeader\getTokenAsEncodedWord(), and Symfony\Component\Mime\Header\AbstractHeader\tokenNeedsEncoding().

Referenced by Symfony\Component\Mime\Header\AbstractHeader\createPhrase(), and Symfony\Component\Mime\Header\UnstructuredHeader\getBodyAsString().

◆ generateTokenLines()

Symfony\Component\Mime\Header\AbstractHeader::generateTokenLines ( string $token )

protected

Generates tokens from the given string which include CRLF as individual tokens.

Returns: string[]

Definition at line 221 of file AbstractHeader.php.

Referenced by Symfony\Component\Mime\Header\ParameterizedHeader\toTokens(), and Symfony\Component\Mime\Header\AbstractHeader\toTokens().

◆ getCharset()

Symfony\Component\Mime\Header\AbstractHeader::getCharset ( )

Implements Symfony\Component\Mime\Header\HeaderInterface.

Definition at line 42 of file AbstractHeader.php.

Referenced by Symfony\Component\Mime\Header\MailboxListHeader\getAddressStrings(), and Symfony\Component\Mime\Header\MailboxHeader\getBodyAsString().

◆ getEncodableWordTokens()

Symfony\Component\Mime\Header\AbstractHeader::getEncodableWordTokens ( string $string )

protected

Splits a string into tokens in blocks of words which can be encoded quickly.

Returns: string[]

Definition at line 158 of file AbstractHeader.php.

References Symfony\Component\Mime\Header\AbstractHeader\tokenNeedsEncoding().

Referenced by Symfony\Component\Mime\Header\AbstractHeader\encodeWords().

◆ getLanguage()

Symfony\Component\Mime\Header\AbstractHeader::getLanguage ( )

Implements Symfony\Component\Mime\Header\HeaderInterface.

Definition at line 57 of file AbstractHeader.php.

◆ getMaxLineLength()

Symfony\Component\Mime\Header\AbstractHeader::getMaxLineLength ( )

Implements Symfony\Component\Mime\Header\HeaderInterface.

Definition at line 72 of file AbstractHeader.php.

◆ getName()

Symfony\Component\Mime\Header\AbstractHeader::getName ( )

Implements Symfony\Component\Mime\Header\HeaderInterface.

Definition at line 62 of file AbstractHeader.php.

◆ getTokenAsEncodedWord()

Symfony\Component\Mime\Header\AbstractHeader::getTokenAsEncodedWord	(	string	$token,
		int	$firstLineOffset = `0`
	)

protected

Get a token as an encoded word for safe insertion into headers.

Definition at line 184 of file AbstractHeader.php.

Referenced by Symfony\Component\Mime\Header\AbstractHeader\encodeWords().

◆ setCharset()

Symfony\Component\Mime\Header\AbstractHeader::setCharset ( string $charset )

Implements Symfony\Component\Mime\Header\HeaderInterface.

Definition at line 37 of file AbstractHeader.php.

◆ setLanguage()

Symfony\Component\Mime\Header\AbstractHeader::setLanguage ( string $lang )

Set the language used in this Header.

For example, for US English, 'en-us'.

Implements Symfony\Component\Mime\Header\HeaderInterface.

Definition at line 52 of file AbstractHeader.php.

◆ setMaxLineLength()

Symfony\Component\Mime\Header\AbstractHeader::setMaxLineLength ( int $lineLength )

Implements Symfony\Component\Mime\Header\HeaderInterface.

Definition at line 67 of file AbstractHeader.php.

◆ tokenNeedsEncoding()

Symfony\Component\Mime\Header\AbstractHeader::tokenNeedsEncoding ( string $token )

protected

Reimplemented in Symfony\Component\Mime\Header\MailboxListHeader, and Symfony\Component\Mime\Header\MailboxHeader.

Definition at line 148 of file AbstractHeader.php.

Referenced by Symfony\Component\Mime\Header\AbstractHeader\encodeWords(), and Symfony\Component\Mime\Header\AbstractHeader\getEncodableWordTokens().

◆ toString()

Symfony\Component\Mime\Header\AbstractHeader::toString ( )

Gets this Header rendered as a compliant string.

Implements Symfony\Component\Mime\Header\HeaderInterface.

Definition at line 77 of file AbstractHeader.php.

References Symfony\Component\Mime\Header\AbstractHeader\toTokens().

◆ toTokens()

Symfony\Component\Mime\Header\AbstractHeader::toTokens ( string $string = null )

protected

Generate a list of all tokens in the final header.

Reimplemented in Symfony\Component\Mime\Header\ParameterizedHeader.

Definition at line 229 of file AbstractHeader.php.

References Symfony\Component\Mime\Header\AbstractHeader\generateTokenLines(), and Symfony\Component\Mime\Header\HeaderInterface\getBodyAsString().

Referenced by Symfony\Component\Mime\Header\AbstractHeader\toString().

Field Documentation

◆ PHRASE_PATTERN

const Symfony\Component\Mime\Header\AbstractHeader::PHRASE_PATTERN = '(?:(?:(?:(?:(?:(?:(?:[ \t]*(?:\r\n))?[ \t])?($(?:(?:(?:[ \t]*(?:\r\n))?[ \t])|(?:(?:[\x01-\x08\x0B\x0C\x0E-\x19\x7F]|[\x21-\x27\x2A-\x5B\x5D-\x7E])|(?:\\[\x00-\x08\x0B\x0C\x0E-\x7F])|(?1)))*(?:(?:[ \t]*(?:\r\n))?[ \t])?$))*(?:(?:(?:(?:[ \t]*(?:\r\n))?[ \t])?($(?:(?:(?:[ \t]*(?:\r\n))?[ \t])|(?:(?:[\x01-\x08\x0B\x0C\x0E-\x19\x7F]|[\x21-\x27\x2A-\x5B\x5D-\x7E])|(?:\\[\x00-\x08\x0B\x0C\x0E-\x7F])|(?1)))*(?:(?:[ \t]*(?:\r\n))?[ \t])?$))|(?:(?:[ \t]*(?:\r\n))?[ \t])))?[a-zA-Z0-9!#\$%&\'\*\+\-\/=\?\^_`\{\}\|~]+(?:(?:(?:(?:[ \t]*(?:\r\n))?[ \t])?($(?:(?:(?:[ \t]*(?:\r\n))?[ \t])|(?:(?:[\x01-\x08\x0B\x0C\x0E-\x19\x7F]|[\x21-\x27\x2A-\x5B\x5D-\x7E])|(?:\\[\x00-\x08\x0B\x0C\x0E-\x7F])|(?1)))*(?:(?:[ \t]*(?:\r\n))?[ \t])?$))*(?:(?:(?:(?:[ \t]*(?:\r\n))?[ \t])?($(?:(?:(?:[ \t]*(?:\r\n))?[ \t])|(?:(?:[\x01-\x08\x0B\x0C\x0E-\x19\x7F]|[\x21-\x27\x2A-\x5B\x5D-\x7E])|(?:\\[\x00-\x08\x0B\x0C\x0E-\x7F])|(?1)))*(?:(?:[ \t]*(?:\r\n))?[ \t])?$))|(?:(?:[ \t]*(?:\r\n))?[ \t])))?)|(?:(?:(?:(?:(?:[ \t]*(?:\r\n))?[ \t])?($(?:(?:(?:[ \t]*(?:\r\n))?[ \t])|(?:(?:[\x01-\x08\x0B\x0C\x0E-\x19\x7F]|[\x21-\x27\x2A-\x5B\x5D-\x7E])|(?:\\[\x00-\x08\x0B\x0C\x0E-\x7F])|(?1)))*(?:(?:[ \t]*(?:\r\n))?[ \t])?$))*(?:(?:(?:(?:[ \t]*(?:\r\n))?[ \t])?($(?:(?:(?:[ \t]*(?:\r\n))?[ \t])|(?:(?:[\x01-\x08\x0B\x0C\x0E-\x19\x7F]|[\x21-\x27\x2A-\x5B\x5D-\x7E])|(?:\\[\x00-\x08\x0B\x0C\x0E-\x7F])|(?1)))*(?:(?:[ \t]*(?:\r\n))?[ \t])?$))|(?:(?:[ \t]*(?:\r\n))?[ \t])))?"((?:(?:[ \t]*(?:\r\n))?[ \t])?(?:(?:[\x01-\x08\x0B\x0C\x0E-\x19\x7F]|[\x21\x23-\x5B\x5D-\x7E])|(?:\\[\x00-\x08\x0B\x0C\x0E-\x7F])))*(?:(?:[ \t]*(?:\r\n))?[ \t])?"(?:(?:(?:(?:[ \t]*(?:\r\n))?[ \t])?($(?:(?:(?:[ \t]*(?:\r\n))?[ \t])|(?:(?:[\x01-\x08\x0B\x0C\x0E-\x19\x7F]|[\x21-\x27\x2A-\x5B\x5D-\x7E])|(?:\\[\x00-\x08\x0B\x0C\x0E-\x7F])|(?1)))*(?:(?:[ \t]*(?:\r\n))?[ \t])?$))*(?:(?:(?:(?:[ \t]*(?:\r\n))?[ \t])?($(?:(?:(?:[ \t]*(?:\r\n))?[ \t])|(?:(?:[\x01-\x08\x0B\x0C\x0E-\x19\x7F]|[\x21-\x27\x2A-\x5B\x5D-\x7E])|(?:\\[\x00-\x08\x0B\x0C\x0E-\x7F])|(?1)))*(?:(?:[ \t]*(?:\r\n))?[ \t])?$))|(?:(?:[ \t]*(?:\r\n))?[ \t])))?))+?)'

Definition at line 23 of file AbstractHeader.php.

The documentation for this class was generated from the following file:

AbstractHeader.php

Public Member Functions

Data Fields

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ createPhrase()

◆ encodeWords()

◆ generateTokenLines()

◆ getCharset()

◆ getEncodableWordTokens()

◆ getLanguage()

◆ getMaxLineLength()

◆ getName()

◆ getTokenAsEncodedWord()

◆ setCharset()

◆ setLanguage()

◆ setMaxLineLength()

◆ tokenNeedsEncoding()

◆ toString()

◆ toTokens()

Field Documentation

◆ PHRASE_PATTERN