Class Swift_Mime_Headers_UnstructuredHeader
| Inheritance | Swift_Mime_Headers_UnstructuredHeader » Swift_Mime_Headers_AbstractHeader |
|---|---|
| Implements | Swift_Mime_Header |
| Subclasses | Swift_Mime_Headers_ParameterizedHeader |
A Simple MIME Header.
Public Methods
| Method | Description | Defined By |
|---|---|---|
| __construct() | Creates a new SimpleHeader with $name. | Swift_Mime_Headers_UnstructuredHeader |
| __toString() | Returns a string representation of this object. | Swift_Mime_Headers_AbstractHeader |
| getCharset() | Get the character set used in this Header. | Swift_Mime_Headers_AbstractHeader |
| getEncoder() | Get the encoder used for encoding this Header. | Swift_Mime_Headers_AbstractHeader |
| getFieldBody() | Get the value of this header prepared for rendering. | Swift_Mime_Headers_UnstructuredHeader |
| getFieldBodyModel() | Get the model for the field body. | Swift_Mime_Headers_UnstructuredHeader |
| getFieldName() | Get the name of this header (e.g. charset). | Swift_Mime_Headers_AbstractHeader |
| getFieldType() | Get the type of Header that this instance represents. | Swift_Mime_Headers_UnstructuredHeader |
| getGrammar() | Get the grammar used for this Header. | 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 |
| getValue() | Get the (unencoded) value of this header. | Swift_Mime_Headers_UnstructuredHeader |
| 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 |
| setFieldBodyModel() | Set the model for the field body. | Swift_Mime_Headers_UnstructuredHeader |
| setGrammar() | Set the grammar used for the header. | 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 |
| setValue() | Set the (unencoded) value of this header. | Swift_Mime_Headers_UnstructuredHeader |
| toString() | Get this Header rendered as a RFC 2822 compliant string. | Swift_Mime_Headers_AbstractHeader |
Protected Methods
| Method | Description | Defined By |
|---|---|---|
| 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 |
| 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 |
| getEncodableWordTokens() | Splits a string into tokens in blocks of words which can be encoded quickly. | Swift_Mime_Headers_AbstractHeader |
| getTokenAsEncodedWord() | Get a token as an encoded word for safe insertion into headers. | Swift_Mime_Headers_AbstractHeader |
| setCachedValue() | Set a value into the cache. | Swift_Mime_Headers_AbstractHeader |
| setFieldName() | Set the name of this Header field. | Swift_Mime_Headers_AbstractHeader |
| toTokens() | Generate a list of all tokens in the final header. | Swift_Mime_Headers_AbstractHeader |
| tokenNeedsEncoding() | Test if a token needs to be encoded or not. | Swift_Mime_Headers_AbstractHeader |
Method Details
Creates a new SimpleHeader with $name.
| public void __construct ( $name, Swift_Mime_HeaderEncoder $encoder, Swift_Mime_Grammar $grammar ) | ||
| $name | string | |
| $encoder | Swift_Mime_HeaderEncoder | |
| $grammar | Swift_Mime_Grammar | |
Get the value of this header prepared for rendering.
| public string getFieldBody ( ) |
Get the model for the field body.
This method returns a string.
| public string getFieldBodyModel ( ) |
Get the type of Header that this instance represents.
See also:
- [[TYPE_TEXT,]] TYPE_PARAMETERIZED, TYPE_MAILBOX.
- [[TYPE_DATE,]] TYPE_ID, TYPE_PATH.
| public int getFieldType ( ) |
Get the (unencoded) value of this header.
| public string getValue ( ) |
Set the model for the field body.
This method takes a string for the field value.
| public void setFieldBodyModel ( $model ) | ||
| $model | string | |
Set the (unencoded) value of this header.
| public void setValue ( $value ) | ||
| $value | string | |