Swift_Mime_Header Interface Reference

Inheritance diagram for Swift_Mime_Header:

Public Member Functions
	getFieldType ()
	setFieldBodyModel ($model)
	setCharset ($charset)
	getFieldBodyModel ()
	getFieldName ()
	getFieldBody ()
	toString ()

Public Attributes
const	TYPE_TEXT = 2
const	TYPE_PARAMETERIZED = 6
const	TYPE_MAILBOX = 8
const	TYPE_DATE = 16
const	TYPE_ID = 32
const	TYPE_PATH = 64

Detailed Description

A MIME Header.

Author

Chris Corbyn

Definition at line 16 of file Header.php.

Member Function Documentation

getFieldBody

(

)

Get the field body, prepared for folding into a final header value.

Returns

string

Implemented in Swift_Mime_Headers_MailboxHeader, Swift_Mime_Headers_IdentificationHeader, Swift_Mime_Headers_ParameterizedHeader, Swift_Mime_Headers_PathHeader, Swift_Mime_Headers_DateHeader, Swift_Mime_Headers_OpenDKIMHeader, and Swift_Mime_Headers_UnstructuredHeader.

Referenced by Swift_Mime_Headers_AbstractHeader\toTokens().

getFieldBodyModel

(

)

Get the model for the field body.

The return type depends on the specifics of the Header.

Returns

mixed

Implemented in Swift_Mime_Headers_DateHeader, Swift_Mime_Headers_OpenDKIMHeader, Swift_Mime_Headers_MailboxHeader, Swift_Mime_Headers_IdentificationHeader, Swift_Mime_Headers_UnstructuredHeader, and Swift_Mime_Headers_PathHeader.

getFieldName

(

)

Get the name of this header (e.g. Subject).

The name is an identifier and as such will be immutable.

Returns

string

Implemented in Swift_Mime_Headers_AbstractHeader, and Swift_Mime_Headers_OpenDKIMHeader.

Referenced by Swift_Mime_SimpleHeaderSet\_isDisplayed(), Swift_Mime_Headers_AbstractHeader\createPhrase(), and Swift_Mime_Headers_AbstractHeader\encodeWords().

getFieldType

(

)

Get the type of Header that this instance represents.

See Also

TYPE_TEXT, TYPE_PARAMETERIZED, TYPE_MAILBOX

TYPE_DATE, TYPE_ID, TYPE_PATH

Returns

int

Implemented in Swift_Mime_Headers_ParameterizedHeader, Swift_Mime_Headers_DateHeader, Swift_Mime_Headers_OpenDKIMHeader, Swift_Mime_Headers_IdentificationHeader, Swift_Mime_Headers_MailboxHeader, Swift_Mime_Headers_UnstructuredHeader, and Swift_Mime_Headers_PathHeader.

setCharset

(

$charset

)

Set the charset used when rendering the Header.

Parameters

string

$charset

Implemented in Swift_Mime_Headers_OpenDKIMHeader, Swift_Mime_Headers_AbstractHeader, and Swift_Mime_Headers_ParameterizedHeader.

Referenced by Swift_Mime_SimpleHeaderFactory\_setHeaderCharset().

setFieldBodyModel

(

$model

)

Set the model for the field body.

The actual types needed will vary depending upon the type of Header.

Parameters

mixed

$model

Implemented in Swift_Mime_Headers_DateHeader, Swift_Mime_Headers_OpenDKIMHeader, Swift_Mime_Headers_IdentificationHeader, Swift_Mime_Headers_MailboxHeader, Swift_Mime_Headers_UnstructuredHeader, and Swift_Mime_Headers_PathHeader.

toString

(

)

Get this Header rendered as a compliant string.

Returns

string

Implemented in Swift_Mime_Headers_AbstractHeader, and Swift_Mime_Headers_OpenDKIMHeader.

Member Data Documentation

const TYPE_DATE = 16

Date and time headers

Definition at line 28 of file Header.php.

const TYPE_ID = 32

Identification headers

Definition at line 31 of file Header.php.

const TYPE_MAILBOX = 8

Mailbox and address headers

Definition at line 25 of file Header.php.

const TYPE_PARAMETERIZED = 6

headers (text + params)

Definition at line 22 of file Header.php.

const TYPE_PATH = 64

Address path headers

Definition at line 34 of file Header.php.

const TYPE_TEXT = 2

Text headers

Definition at line 19 of file Header.php.