Class Swift_Mime_Headers_AbstractHeader

An abstract base MIME Header.

Swift_Mime_Headers_AbstractHeader implements Swift_Mime_Header

Direct known subclasses

Swift_Mime_Headers_DateHeader, Swift_Mime_Headers_IdentificationHeader, Swift_Mime_Headers_MailboxHeader, Swift_Mime_Headers_PathHeader, Swift_Mime_Headers_UnstructuredHeader

Indirect known subclasses

Swift_Mime_Headers_ParameterizedHeader

Abstract
Package: Swift\Mime
Author: Chris Corbyn
Located at classes/swiftmailer/lib/classes/Swift/Mime/Headers/AbstractHeader.php

Methods summary
`public`	# `__construct( Swift_Mime_Grammar $grammar )` Creates a new Header. Creates a new Header. Parameters `$grammar`
`public`	# `setCharset( string $charset )` Set the character set used in this Header. Set the character set used in this Header. Parameters `$charset` Implementation of `Swift_Mime_Header::setCharset()`
`public string`	# `getCharset( )` Get the character set used in this Header. Get the character set used in this Header. Returns string
`public`	# `setLanguage( string $lang )` Set the language used in this Header. For example, for US English, 'en-us'. This can be unspecified. Set the language used in this Header. For example, for US English, 'en-us'. This can be unspecified. Parameters `$lang`
`public string`	# `getLanguage( )` Get the language used in this Header. Get the language used in this Header. Returns string
`public`	# `setEncoder( Swift_Mime_HeaderEncoder $encoder )` Set the encoder used for encoding the header. Set the encoder used for encoding the header. Parameters `$encoder`
`public Swift_Mime_HeaderEncoder`	# `getEncoder( )` Get the encoder used for encoding this Header. Get the encoder used for encoding this Header. Returns `Swift_Mime_HeaderEncoder`
`public`	# `setGrammar( Swift_Mime_Grammar $grammar )` Set the grammar used for the header. Set the grammar used for the header. Parameters `$grammar`
`public Swift_Mime_Grammar`	# `getGrammar( )` Get the grammar used for this Header. Get the grammar used for this Header. Returns `Swift_Mime_Grammar`
`public string`	# `getFieldName( )` Get the name of this header (e.g. charset). Get the name of this header (e.g. charset). Returns string Implementation of `Swift_Mime_Header::getFieldName()`
`public`	# `setMaxLineLength( integer $lineLength )` Set the maximum length of lines in the header (excluding EOL). Set the maximum length of lines in the header (excluding EOL). Parameters `$lineLength`
`public integer`	# `getMaxLineLength( )` Get the maximum permitted length of lines in this Header. Get the maximum permitted length of lines in this Header. Returns integer
`public string`	# `toString( )` Get this Header rendered as a RFC 2822 compliant string. Get this Header rendered as a RFC 2822 compliant string. Returns string Throws `Swift_RfcComplianceException` Implementation of `Swift_Mime_Header::toString()`
`public string`	# `__toString( )` Returns a string representation of this object. Returns a string representation of this object. Returns string See `Swift_Mime_Headers_AbstractHeader::toString()`
`protected`	# `setFieldName( string $name )` Set the name of this Header field. Set the name of this Header field. Parameters `$name`
`protected string`	# `createPhrase( Swift_Mime_Header $header, string $string, string $charset, Swift_Mime_HeaderEncoder $encoder = null, boolean $shorten = false )` Produces a compliant, formatted RFC 2822 'phrase' based on the string given. Produces a compliant, formatted RFC 2822 'phrase' based on the string given. Parameters `$header` `$string` as displayed `$charset` of the text `$encoder` `$shorten` the first line to make remove for header name Returns string
`protected string`	# `encodeWords( Swift_Mime_Header $header, string $input, $usedLength = -1 )` Encode needed word tokens within a string of input. Encode needed word tokens within a string of input. Parameters `$header` $input `$input` $usedLength, optional `$usedLength` Returns string
`protected boolean`	# `tokenNeedsEncoding( string $token )` Test if a token needs to be encoded or not. Test if a token needs to be encoded or not. Parameters `$token` Returns boolean
`protected string[]`	# `getEncodableWordTokens( string $string )` Splits a string into tokens in blocks of words which can be encoded quickly. Splits a string into tokens in blocks of words which can be encoded quickly. Parameters `$string` Returns string[]
`protected string`	# `getTokenAsEncodedWord( string $token, integer $firstLineOffset = 0 )` Get a token as an encoded word for safe insertion into headers. Get a token as an encoded word for safe insertion into headers. Parameters `$token` to encode `$firstLineOffset` $firstLineOffset, optional Returns string
`protected string[]`	# `generateTokenLines( string $token )` Generates tokens from the given string which include CRLF as individual tokens. Generates tokens from the given string which include CRLF as individual tokens. Parameters `$token` Returns string[]
`protected`	# `setCachedValue( string $value )` Set a value into the cache. Set a value into the cache. Parameters `$value`
`protected string`	# `getCachedValue( )` Get the value in the cache. Get the value in the cache. Returns string
`protected`	# `clearCachedValueIf( boolean $condition )` Clear the cached value if $condition is met. Clear the cached value if $condition is met. Parameters `$condition`
`protected array`	# `toTokens( string $string = null )` Generate a list of all tokens in the final header. Generate a list of all tokens in the final header. Parameters `$string` The string to tokenize Returns array An array of tokens as strings
`private string`	# `_tokensToString( array $tokens )` Takes an array of tokens which appear in the header and turns them into an RFC 2822 compliant string, adding FWSP where needed. Takes an array of tokens which appear in the header and turns them into an RFC 2822 compliant string, adding FWSP where needed. Parameters `$tokens` Returns string

Methods inherited from Swift_Mime_Header
`getFieldBody(), getFieldBodyModel(), getFieldType(), setFieldBodyModel()`

Constants inherited from Swift_Mime_Header
`TYPE_DATE, TYPE_ID, TYPE_MAILBOX, TYPE_PARAMETERIZED, TYPE_PATH, TYPE_TEXT`

Properties summary
`private string`	`$_name` The name of this Header. The name of this Header.	#
`private Swift_Mime_Grammar`	`$_grammar` The Grammar used for this Header. The Grammar used for this Header.	#
`private Swift_Encoder`	`$_encoder` The Encoder used to encode this Header. The Encoder used to encode this Header.	#
`private integer`	`$_lineLength` The maximum length of a line in the header. The maximum length of a line in the header.	# `78`
`private string`	`$_lang` The language used in this Header. The language used in this Header.	#
`private string`	`$_charset` The character set of the text in this Header. The character set of the text in this Header.	# `'utf-8'`
`private string`	`$_cachedValue` The value of this Header, cached. The value of this Header, cached.	# `null`

Packages

Classes

Interfaces

Class Swift_Mime_Headers_AbstractHeader

Direct known subclasses

Indirect known subclasses

Parameters

Parameters

Implementation of

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Implementation of

Parameters

Returns

Returns

Throws

Implementation of

Returns

See

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Returns