Class: Swift_Mime_Headers_UnstructuredHeader

Source Location: /vendors/swift/classes/Swift/Mime/Headers/UnstructuredHeader.php

Class Overview

Swift_Mime_Headers_AbstractHeader
   |
   --Swift_Mime_Headers_UnstructuredHeader

A Simple MIME Header.

Author(s):

Chris Corbyn

Methods

Child classes:

Swift_Mime_Headers_ParameterizedHeader: An abstract base MIME Header.

Inherited Methods

Class: Swift_Mime_Headers_AbstractHeader

Swift_Mime_Headers_AbstractHeader::clearCachedValueIf(): Clear the cached value if $condition is met.
Swift_Mime_Headers_AbstractHeader::createPhrase(): Produces a compliant, formatted RFC 2822 'phrase' based on the string given.
Swift_Mime_Headers_AbstractHeader::encodeWords(): Encode needed word tokens within a string of input.
Swift_Mime_Headers_AbstractHeader::escapeSpecials(): Escape special characters in a string (convert to quoted-pairs).
Swift_Mime_Headers_AbstractHeader::generateTokenLines(): Generates tokens from the given string which include CRLF as individual tokens.
Swift_Mime_Headers_AbstractHeader::getCachedValue(): Get the value in the cache.
Swift_Mime_Headers_AbstractHeader::getCharset(): Get the character set used in this Header.
Swift_Mime_Headers_AbstractHeader::getEncodableWordTokens(): Splits a string into tokens in blocks of words which can be encoded quickly.
Swift_Mime_Headers_AbstractHeader::getEncoder(): Get the encoder used for encoding this Header.
Swift_Mime_Headers_AbstractHeader::getFieldName(): Get the name of this header (e.g. charset).
Swift_Mime_Headers_AbstractHeader::getGrammar(): Get the grammar defined for $name token.
Swift_Mime_Headers_AbstractHeader::getLanguage(): Get the language used in this Header.
Swift_Mime_Headers_AbstractHeader::getMaxLineLength(): Get the maximum permitted length of lines in this Header.
Swift_Mime_Headers_AbstractHeader::getTokenAsEncodedWord(): Get a token as an encoded word for safe insertion into headers.
Swift_Mime_Headers_AbstractHeader::initializeGrammar(): Initialize some RFC 2822 (and friends) ABNF grammar definitions.
Swift_Mime_Headers_AbstractHeader::setCachedValue(): Set a value into the cache.
Swift_Mime_Headers_AbstractHeader::setCharset(): Set the character set used in this Header.
Swift_Mime_Headers_AbstractHeader::setEncoder(): Set the encoder used for encoding the header.
Swift_Mime_Headers_AbstractHeader::setFieldName(): Set the name of this Header field.
Swift_Mime_Headers_AbstractHeader::setLanguage(): Set the language used in this Header.
Swift_Mime_Headers_AbstractHeader::setMaxLineLength(): Set the maximum length of lines in the header (excluding EOL).
Swift_Mime_Headers_AbstractHeader::tokenNeedsEncoding(): Test if a token needs to be encoded or not.
Swift_Mime_Headers_AbstractHeader::toString(): Get this Header rendered as a RFC 2822 compliant string.
Swift_Mime_Headers_AbstractHeader::toTokens(): Generate a list of all tokens in the final header.
Swift_Mime_Headers_AbstractHeader::__toString(): Returns a string representation of this object.

Class Details

[line 20]
A Simple MIME Header.

Tags:

author:	Chris Corbyn
filesource:	Source Code for this file

[ Top ]

Class Methods

constructor __construct [line 36]

Swift_Mime_Headers_UnstructuredHeader __construct(
string
$name, Swift_Mime_HeaderEncoder
$encoder)

Creates a new SimpleHeader with $name.

Parameters:

string	$name
Swift_Mime_HeaderEncoder	$encoder

[ Top ]

method getFieldBody [line 95]

string getFieldBody(
)

Get the value of this header prepared for rendering.

method getFieldBodyModel [line 67]

string getFieldBodyModel(
)

Get the model for the field body.

This method returns a string.

Tags:

access:

public

[ Top ]

method getFieldType [line 47]

int getFieldType(
)

Get the type of Header that this instance represents.

Tags:

see:	TYPE_TEXT, TYPE_PARAMETERIZED, TYPE_MAILBOX
see:	TYPE_DATE, TYPE_ID, TYPE_PATH
access:	public

Overridden in child classes as:

Swift_Mime_Headers_ParameterizedHeader::getFieldType(): Get the type of Header that this instance represents.

[ Top ]

method getValue [line 76]

string getValue(
)

Get the (unencoded) value of this header.

Tags:

access:

public

[ Top ]

method setFieldBodyModel [line 57]

void setFieldBodyModel(
string
$model)

Set the model for the field body.

This method takes a string for the field value.

Tags:

access:

public

Parameters:

string

$model

[ Top ]

method setValue [line 85]

void setValue(
string
$value)

Set the (unencoded) value of this header.

Tags:

access:

public

Parameters:

string

$value

[ Top ]

Documentation generated on Mon, 05 Sep 2011 20:34:47 -0500 by phpDocumentor 1.4.3