Interface Swift_Mime_Header
A MIME Header.
Public Methods
Method | Description | Defined By |
---|---|---|
getFieldBody() | Get the field body, prepared for folding into a final header value. | Swift_Mime_Header |
getFieldBodyModel() | Get the model for the field body. | Swift_Mime_Header |
getFieldName() | Get the name of this header (e.g. Subject). | Swift_Mime_Header |
getFieldType() | Get the type of Header that this instance represents. | Swift_Mime_Header |
setCharset() | Set the charset used when rendering the Header. | Swift_Mime_Header |
setFieldBodyModel() | Set the model for the field body. | Swift_Mime_Header |
toString() | Get this Header rendered as a compliant string. | Swift_Mime_Header |
Method Details
Get the field body, prepared for folding into a final header value.
public abstract string getFieldBody ( ) |
Get the model for the field body.
The return type depends on the specifics of the Header.
public abstract mixed getFieldBodyModel ( ) |
Get the name of this header (e.g. Subject).
The name is an identifier and as such will be immutable.
public abstract string getFieldName ( ) |
Get the type of Header that this instance represents.
See also:
- [[TYPE_TEXT,]] TYPE_PARAMETERIZED, TYPE_MAILBOX.
- [[TYPE_DATE,]] TYPE_ID, TYPE_PATH.
public abstract int getFieldType ( ) |
Set the charset used when rendering the Header.
public abstract void setCharset ( $charset ) | ||
$charset | string |
Set the model for the field body.
The actual types needed will vary depending upon the type of Header.
public abstract void setFieldBodyModel ( $model ) | ||
$model | mixed |
Get this Header rendered as a compliant string.
public abstract string toString ( ) |