Documentation

Swift_Mime_Headers_ParameterizedHeader extends Swift_Mime_Headers_UnstructuredHeader

in package

• Application

An abstract base MIME Header.

Tags

author

Chris Corbyn

Table of Contents

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])))?))+?)'

TOKEN_REGEX  = '(?:[\x21\x23-\x27\x2A\x2B\x2D\x2E\x30-\x39\x41-\x5A\x5E-\x7E]+)'

RFC 2231's definition of a token.

$cachedValue  : string

The value of this Header, cached.

$charset  : string

The character set of the text in this Header.

$encoder  : Swift_Encoder

The Encoder used to encode this Header.

$lang  : string

The language used in this Header.

$lineLength  : int

The maximum length of a line in the header.

$name  : string

The name of this Header.

$paramEncoder  : Swift_Encoder

The Encoder used to encode the parameters.

$params  : array<string|int, string>

The parameters as an associative array.

$value  : string

The value of this Header.

__construct()  : mixed

Creates a new ParameterizedHeader with $name.

__toString()  : string

Returns a string representation of this object.

getCharset()  : string

Get the character set used in this Header.

getEncoder()  : Swift_Mime_HeaderEncoder

Get the encoder used for encoding this Header.

getFieldBody()  : string

Get the value of this header prepared for rendering.

getFieldBodyModel()  : string

Get the model for the field body.

getFieldName()  : string

Get the name of this header (e.g. charset).

getFieldType()  : int

Get the type of Header that this instance represents.

getLanguage()  : string

Get the language used in this Header.

getMaxLineLength()  : int

Get the maximum permitted length of lines in this Header.

getParameter()  : string

Get the value of $parameter.

getParameters()  : array<string|int, string>

Returns an associative array of parameter names mapped to values.

getValue()  : string

Get the (unencoded) value of this header.

setCharset()  : mixed

Set the character set used in this Header.

setEncoder()  : mixed

Set the encoder used for encoding the header.

setFieldBodyModel()  : mixed

Set the model for the field body.

setLanguage()  : mixed

Set the language used in this Header.

setMaxLineLength()  : mixed

Set the maximum length of lines in the header (excluding EOL).

setParameter()  : mixed

Set the value of $parameter.

setParameters()  : mixed

Set an associative array of parameter names mapped to values.

setValue()  : mixed

Set the (unencoded) value of this header.

toString()  : string

Get this Header rendered as a RFC 2822 compliant string.

clearCachedValueIf()  : mixed

Clear the cached value if $condition is met.

createPhrase()  : string

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

encodeWords()  : string

Encode needed word tokens within a string of input.

generateTokenLines()  : array<string|int, string>

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

getCachedValue()  : string

Get the value in the cache.

getEncodableWordTokens()  : array<string|int, string>

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

getTokenAsEncodedWord()  : string

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

setCachedValue()  : mixed

Set a value into the cache.

setFieldName()  : mixed

Set the name of this Header field.

tokenNeedsEncoding()  : bool

Test if a token needs to be encoded or not.

toTokens()  : array<string|int, mixed>

Generate a list of all tokens in the final header.

createParameter()  : string

Render a RFC 2047 compliant header parameter from the $name and $value.

escapeSpecials()  : string

Escape special characters in a string (convert to quoted-pairs).

getEndOfParameterValue()  : string

Returns the parameter value from the "=" and beyond.

tokensToString()  : string

Takes an array of tokens which appear in the header and turns them into an RFC 2822 compliant string, adding FWSP where needed.