CONTENIDO_4.9.0 beta1
Back to top  

A MIME Header with parameters.

package Swift
subpackage Mime
author Chris Corbyn

 Methods

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

getFieldBody() : string
Inherited
inherited_from \Swift_Mime_Header::getFieldBody()

Returns

string

Get the model for the field body.

getFieldBodyModel() : mixed
Inherited

The return type depends on the specifics of the Header.

inherited_from \Swift_Mime_Header::getFieldBodyModel()

Returns

mixed

Get the name of this header (e.g.

getFieldName() : string
Inherited

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

inherited_from \Swift_Mime_Header::getFieldName()

Returns

string

Get the type of Header that this instance represents.

getFieldType() : int
Inherited
see TYPE_PARAMETERIZED, TYPE_MAILBOX
see TYPE_ID, TYPE_PATH
inherited_from \Swift_Mime_Header::getFieldType()

Returns

int

Get the value of $parameter.

getParameter($parameter) : string

Parameters

$parameter

Returns

string

Set the charset used when rendering the Header.

setCharset(string $charset) 
Inherited
inherited_from \Swift_Mime_Header::setCharset()

Parameters

$charset

string

Set the model for the field body.

setFieldBodyModel(mixed $model) 
Inherited

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

inherited_from \Swift_Mime_Header::setFieldBodyModel()

Parameters

$model

mixed

Set the value of $parameter.

setParameter(string $parameter, string $value) 

Parameters

$parameter

string

$value

string

Get this Header rendered as a compliant string.

toString() : string
Inherited
inherited_from \Swift_Mime_Header::toString()

Returns

string

 Constants

 

Date and time headers

TYPE_DATE 
Inherited
inherited_from \Swift_Mime_Header::TYPE_DATE
 

Identification headers

TYPE_ID 
Inherited
inherited_from \Swift_Mime_Header::TYPE_ID
 

Mailbox and address headers

TYPE_MAILBOX 
Inherited
inherited_from \Swift_Mime_Header::TYPE_MAILBOX
 

Parameterized headers (text + params)

TYPE_PARAMETERIZED 
Inherited
inherited_from \Swift_Mime_Header::TYPE_PARAMETERIZED
 

Address path headers

TYPE_PATH 
Inherited
inherited_from \Swift_Mime_Header::TYPE_PATH
 

Text headers

TYPE_TEXT 
Inherited
inherited_from \Swift_Mime_Header::TYPE_TEXT