An abstract base MIME Header.
Methods
Creates a new ParameterizedHeader with $name.
__construct(string $name, \Swift_Mime_HeaderEncoder $encoder, \Swift_Encoder $paramEncoder, \Swift_Mime_Grammar $grammar)
Parameters
$name
string
$paramEncoder
Returns a string representation of this object.
__toString() : string
Inherited
see |
\toString() |
inherited_from |
\Swift_Mime_Headers_AbstractHeader::__toString() |
inherited_from |
\Swift_Mime_Headers_UnstructuredHeader::__toString() |
Returns
string
Get the character set used in this Header.
getCharset() : string
Inherited
inherited_from |
\Swift_Mime_Headers_AbstractHeader::getCharset() |
inherited_from |
\Swift_Mime_Headers_UnstructuredHeader::getCharset() |
Returns
string
Get the encoder used for encoding this Header.
getEncoder() : \Swift_Mime_HeaderEncoder
Inherited
inherited_from |
\Swift_Mime_Headers_AbstractHeader::getEncoder() |
inherited_from |
\Swift_Mime_Headers_UnstructuredHeader::getEncoder() |
Returns
Get the value of this header prepared for rendering.
getFieldBody() : string
Get the model for the field body.
getFieldBodyModel() : mixed
Inherited
The return type depends on the specifics of the Header.
inherited_from |
\Swift_Mime_Header::getFieldBodyModel() |
inherited_from |
\Swift_Mime_ParameterizedHeader::getFieldBodyModel() |
Returns
mixed
Get the name of this header (e.g.
getFieldName() : string
Inherited
Subject).
The name is an identifier and as such will be immutable.
inherited_from |
\Swift_Mime_Header::getFieldName() |
inherited_from |
\Swift_Mime_ParameterizedHeader::getFieldName() |
Returns
string
Get the type of Header that this instance represents.
getFieldType() : int
Get the grammar used for this Header.
getGrammar() : \Swift_Mime_Grammar
Inherited
inherited_from |
\Swift_Mime_Headers_AbstractHeader::getGrammar() |
inherited_from |
\Swift_Mime_Headers_UnstructuredHeader::getGrammar() |
Returns
Get the language used in this Header.
getLanguage() : string
Inherited
inherited_from |
\Swift_Mime_Headers_AbstractHeader::getLanguage() |
inherited_from |
\Swift_Mime_Headers_UnstructuredHeader::getLanguage() |
Returns
string
Get the maximum permitted length of lines in this Header.
getMaxLineLength() : int
Inherited
inherited_from |
\Swift_Mime_Headers_AbstractHeader::getMaxLineLength() |
inherited_from |
\Swift_Mime_Headers_UnstructuredHeader::getMaxLineLength() |
Returns
int
Get the value of $parameter.
getParameter($parameter) : string
Parameters
$parameter
Returns
string
Returns an associative array of parameter names mapped to values.
getParameters() : string[]
Get the (unencoded) value of this header.
getValue() : string
Inherited
inherited_from |
\Swift_Mime_Headers_UnstructuredHeader::getValue() |
Returns
string
Set the character set used in this Header.
setCharset(string $charset)
Parameters
$charset
string
Set the encoder used for encoding the header.
setEncoder(\Swift_Mime_HeaderEncoder $encoder)
Inherited
inherited_from |
\Swift_Mime_Headers_AbstractHeader::setEncoder() |
inherited_from |
\Swift_Mime_Headers_UnstructuredHeader::setEncoder() |
Parameters
Set the model for the field body.
setFieldBodyModel(mixed $model)
Inherited
The actual types needed will vary depending upon the type of Header.
inherited_from |
\Swift_Mime_Header::setFieldBodyModel() |
inherited_from |
\Swift_Mime_ParameterizedHeader::setFieldBodyModel() |
Parameters
$model
mixed
Set the grammar used for the header.
setGrammar(\Swift_Mime_Grammar $grammar)
Inherited
inherited_from |
\Swift_Mime_Headers_AbstractHeader::setGrammar() |
inherited_from |
\Swift_Mime_Headers_UnstructuredHeader::setGrammar() |
Parameters
Set the language used in this Header.
setLanguage(string $lang)
Inherited
For example, for US English, 'en-us'.
This can be unspecified.
inherited_from |
\Swift_Mime_Headers_AbstractHeader::setLanguage() |
inherited_from |
\Swift_Mime_Headers_UnstructuredHeader::setLanguage() |
Parameters
$lang
string
Set the maximum length of lines in the header (excluding EOL).
setMaxLineLength(int $lineLength)
Inherited
inherited_from |
\Swift_Mime_Headers_AbstractHeader::setMaxLineLength() |
inherited_from |
\Swift_Mime_Headers_UnstructuredHeader::setMaxLineLength() |
Parameters
$lineLength
int
Set the value of $parameter.
setParameter(string $parameter, string $value)
Parameters
$parameter
string
$value
string
Set an associative array of parameter names mapped to values.
setParameters(array $parameters)
Parameters
$parameters
string[]
Set the (unencoded) value of this header.
setValue(string $value)
Inherited
inherited_from |
\Swift_Mime_Headers_UnstructuredHeader::setValue() |
Parameters
$value
string
Get this Header rendered as a compliant string.
toString() : string
Inherited
inherited_from |
\Swift_Mime_Header::toString() |
inherited_from |
\Swift_Mime_ParameterizedHeader::toString() |
Exceptions
Returns
string
Clear the cached value if $condition is met.
clearCachedValueIf(boolean $condition)
Inherited
access |
protected |
inherited_from |
\Swift_Mime_Headers_AbstractHeader::clearCachedValueIf() |
inherited_from |
\Swift_Mime_Headers_UnstructuredHeader::clearCachedValueIf() |
Parameters
$condition
boolean
Produces a compliant, formatted RFC 2822 'phrase' based on the string given.
createPhrase(\Swift_Mime_Header $header, string $string, string $charset, \Swift_Mime_HeaderEncoder $encoder, boolean $shorten) : string
Inherited
inherited_from |
\Swift_Mime_Headers_AbstractHeader::createPhrase() |
inherited_from |
\Swift_Mime_Headers_UnstructuredHeader::createPhrase() |
Parameters
$string
string
as displayed
$charset
string
of the text
$shorten
boolean
the first line to make remove for header name
Returns
string
Encode needed word tokens within a string of input.
encodeWords(\Swift_Mime_Header $header, string $input, $usedLength) : string
Inherited
inherited_from |
\Swift_Mime_Headers_AbstractHeader::encodeWords() |
inherited_from |
\Swift_Mime_Headers_UnstructuredHeader::encodeWords() |
Parameters
$header
$input
string
$usedLength
Returns
string
Generates tokens from the given string which include CRLF as individual tokens.
generateTokenLines(string $token) : string[]
Inherited
access |
protected |
inherited_from |
\Swift_Mime_Headers_AbstractHeader::generateTokenLines() |
inherited_from |
\Swift_Mime_Headers_UnstructuredHeader::generateTokenLines() |
Parameters
$token
string
Returns
string[]
Get the value in the cache.
getCachedValue() : string
Inherited
access |
protected |
inherited_from |
\Swift_Mime_Headers_AbstractHeader::getCachedValue() |
inherited_from |
\Swift_Mime_Headers_UnstructuredHeader::getCachedValue() |
Returns
string
Splits a string into tokens in blocks of words which can be encoded quickly.
getEncodableWordTokens(string $string) : string[]
Inherited
inherited_from |
\Swift_Mime_Headers_AbstractHeader::getEncodableWordTokens() |
inherited_from |
\Swift_Mime_Headers_UnstructuredHeader::getEncodableWordTokens() |
Parameters
$string
string
Returns
string[]
Get a token as an encoded word for safe insertion into headers.
getTokenAsEncodedWord(string $token, $firstLineOffset) : string
Inherited
inherited_from |
\Swift_Mime_Headers_AbstractHeader::getTokenAsEncodedWord() |
inherited_from |
\Swift_Mime_Headers_UnstructuredHeader::getTokenAsEncodedWord() |
Parameters
$firstLineOffset
Returns
string
Set a value into the cache.
setCachedValue(string $value)
Inherited
access |
protected |
inherited_from |
\Swift_Mime_Headers_AbstractHeader::setCachedValue() |
inherited_from |
\Swift_Mime_Headers_UnstructuredHeader::setCachedValue() |
Parameters
$value
string
Set the name of this Header field.
setFieldName(string $name)
Inherited
access |
protected |
inherited_from |
\Swift_Mime_Headers_AbstractHeader::setFieldName() |
inherited_from |
\Swift_Mime_Headers_UnstructuredHeader::setFieldName() |
Parameters
$name
string
Generate a list of all tokens in the final header.
toTokens(string $string) : array
This doesn't need to be overridden in theory, but it is for implementation
reasons to prevent potential breakage of attributes.
Parameters
$string
string
The string to tokenize
Returns
array
An array of tokens as strings
Test if a token needs to be encoded or not.
tokenNeedsEncoding(string $token) : boolean
Inherited
inherited_from |
\Swift_Mime_Headers_AbstractHeader::tokenNeedsEncoding() |
inherited_from |
\Swift_Mime_Headers_UnstructuredHeader::tokenNeedsEncoding() |
Parameters
$token
string
Returns
boolean
Render a RFC 2047 compliant header parameter from the $name and $value.
_createParameter(string $name, string $value) : string
Parameters
$name
string
$value
string
Returns
string
Returns the parameter value from the "=" and beyond.
_getEndOfParameterValue(string $value, boolean $encoded, boolean $firstLine) : string
Parameters
$encoded
boolean
$firstLine
boolean
Returns
string
Takes an array of tokens which appear in the header and turns them into
an RFC 2822 compliant string, adding FWSP where needed.
_tokensToString(array $tokens) : string
Inherited
access |
private |
inherited_from |
\Swift_Mime_Headers_AbstractHeader::_tokensToString() |
inherited_from |
\Swift_Mime_Headers_UnstructuredHeader::_tokensToString() |
Parameters
$tokens
string[]
Returns
string
Properties
$_cachedValue : string
Inherited
access |
private |
inherited_from |
\Swift_Mime_Headers_AbstractHeader::$$_cachedValue |
inherited_from |
\Swift_Mime_Headers_UnstructuredHeader::$$_cachedValue |
$_charset : string
Inherited
access |
private |
inherited_from |
\Swift_Mime_Headers_AbstractHeader::$$_charset |
inherited_from |
\Swift_Mime_Headers_UnstructuredHeader::$$_charset |
$_encoder : \Swift_Encoder
Inherited
access |
private |
inherited_from |
\Swift_Mime_Headers_AbstractHeader::$$_encoder |
inherited_from |
\Swift_Mime_Headers_UnstructuredHeader::$$_encoder |
$_grammar : \Swift_Mime_Grammar
Inherited
access |
private |
inherited_from |
\Swift_Mime_Headers_AbstractHeader::$$_grammar |
inherited_from |
\Swift_Mime_Headers_UnstructuredHeader::$$_grammar |
$_lang : string
Inherited
inherited_from |
\Swift_Mime_Headers_AbstractHeader::$$_lang |
inherited_from |
\Swift_Mime_Headers_UnstructuredHeader::$$_lang |
$_lineLength : int
Inherited
access |
private |
inherited_from |
\Swift_Mime_Headers_AbstractHeader::$$_lineLength |
inherited_from |
\Swift_Mime_Headers_UnstructuredHeader::$$_lineLength |
$_name : string
Inherited
access |
private |
inherited_from |
\Swift_Mime_Headers_AbstractHeader::$$_name |
inherited_from |
\Swift_Mime_Headers_UnstructuredHeader::$$_name |
$_value : string
Inherited
access |
private |
inherited_from |
\Swift_Mime_Headers_UnstructuredHeader::$$_value |
Constants
RFC 2231's definition of a token.
TOKEN_REGEX : string
Date and time headers
TYPE_DATE
Inherited
inherited_from |
\Swift_Mime_Header::TYPE_DATE |
inherited_from |
\Swift_Mime_ParameterizedHeader::TYPE_DATE |
Identification headers
TYPE_ID
Inherited
inherited_from |
\Swift_Mime_Header::TYPE_ID |
inherited_from |
\Swift_Mime_ParameterizedHeader::TYPE_ID |
Mailbox and address headers
TYPE_MAILBOX
Inherited
inherited_from |
\Swift_Mime_Header::TYPE_MAILBOX |
inherited_from |
\Swift_Mime_ParameterizedHeader::TYPE_MAILBOX |
Parameterized headers (text + params)
TYPE_PARAMETERIZED
Inherited
inherited_from |
\Swift_Mime_Header::TYPE_PARAMETERIZED |
inherited_from |
\Swift_Mime_ParameterizedHeader::TYPE_PARAMETERIZED |
Address path headers
TYPE_PATH
Inherited
inherited_from |
\Swift_Mime_Header::TYPE_PATH |
inherited_from |
\Swift_Mime_ParameterizedHeader::TYPE_PATH |
Text headers
TYPE_TEXT
Inherited
inherited_from |
\Swift_Mime_Header::TYPE_TEXT |
inherited_from |
\Swift_Mime_ParameterizedHeader::TYPE_TEXT |