Swift_Mime_Header
in
A MIME Header.
Tags
Table of Contents
- TYPE_DATE = 16
- Date and time headers
- TYPE_ID = 32
- Identification headers
- TYPE_MAILBOX = 8
- Mailbox and address headers
- TYPE_PARAMETERIZED = 6
- headers (text + params)
- TYPE_PATH = 64
- Address path headers
- TYPE_TEXT = 2
- Text headers
- getFieldBody() : string
- Get the field body, prepared for folding into a final header value.
- getFieldBodyModel() : mixed
- Get the model for the field body.
- getFieldName() : string
- Get the name of this header (e.g. Subject).
- getFieldType() : int
- Get the type of Header that this instance represents.
- setCharset() : mixed
- Set the charset used when rendering the Header.
- setFieldBodyModel() : mixed
- Set the model for the field body.
- toString() : string
- Get this Header rendered as a compliant string, including trailing CRLF.
Constants
TYPE_DATE
Date and time headers
public
mixed
TYPE_DATE
= 16
TYPE_ID
Identification headers
public
mixed
TYPE_ID
= 32
TYPE_MAILBOX
Mailbox and address headers
public
mixed
TYPE_MAILBOX
= 8
TYPE_PARAMETERIZED
headers (text + params)
public
mixed
TYPE_PARAMETERIZED
= 6
TYPE_PATH
Address path headers
public
mixed
TYPE_PATH
= 64
TYPE_TEXT
Text headers
public
mixed
TYPE_TEXT
= 2
Methods
getFieldBody()
Get the field body, prepared for folding into a final header value.
public
getFieldBody() : string
Return values
string —getFieldBodyModel()
Get the model for the field body.
public
getFieldBodyModel() : mixed
The return type depends on the specifics of the Header.
Return values
mixed —getFieldName()
Get the name of this header (e.g. Subject).
public
getFieldName() : string
The name is an identifier and as such will be immutable.
Return values
string —getFieldType()
Get the type of Header that this instance represents.
public
getFieldType() : int
Tags
Return values
int —setCharset()
Set the charset used when rendering the Header.
public
setCharset(string $charset) : mixed
Parameters
- $charset : string
Return values
mixed —setFieldBodyModel()
Set the model for the field body.
public
setFieldBodyModel(mixed $model) : mixed
The actual types needed will vary depending upon the type of Header.
Parameters
- $model : mixed
Return values
mixed —toString()
Get this Header rendered as a compliant string, including trailing CRLF.
public
toString() : string