Geeklog
[ class tree: Geeklog ] [ index: Geeklog ] [ all elements ]

Class: Swift_Mime_Header

Source Location: /system/vendor/swiftmailer/swiftmailer/lib/classes/Swift/Mime/Header.php

Interface Overview


A MIME Header.


Author(s):

  • Chris Corbyn

Constants

Methods


Child classes:

Swift_Mime_ParameterizedHeader
A MIME Header with parameters.

Class Details

[line 16]
A MIME Header.



Tags:

author:  Chris Corbyn


[ Top ]


Class Methods


method getFieldBody [line 85]

string getFieldBody( )

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



Tags:

access:  public


[ Top ]

method getFieldBodyModel [line 69]

mixed getFieldBodyModel( )

Get the model for the field body.

The return type depends on the specifics of the Header.




Tags:

access:  public


[ Top ]

method getFieldName [line 78]

string getFieldName( )

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

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




Tags:

access:  public


[ Top ]

method getFieldType [line 44]

int getFieldType( )

Get the type of Header that this instance represents.



Tags:



[ Top ]

method setCharset [line 60]

void setCharset( string $charset)

Set the charset used when rendering the Header.



Tags:

access:  public


Parameters:

string   $charset  

[ Top ]

method setFieldBodyModel [line 53]

void setFieldBodyModel( mixed $model)

Set the model for the field body.

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




Tags:

access:  public


Parameters:

mixed   $model  

[ Top ]

method toString [line 92]

string toString( )

Get this Header rendered as a compliant string.



Tags:

access:  public


[ Top ]


Class Constants

TYPE_DATE =  16

[line 28]

Date and time headers


[ Top ]

TYPE_ID =  32

[line 31]

Identification headers


[ Top ]

TYPE_MAILBOX =  8

[line 25]

Mailbox and address headers


[ Top ]

TYPE_PARAMETERIZED =  6

[line 22]

headers (text + params)


[ Top ]

TYPE_PATH =  64

[line 34]

Address path headers


[ Top ]

TYPE_TEXT =  2

[line 19]

Text headers


[ Top ]



Documentation generated on Sun, 02 Oct 2016 07:49:28 +0000 by phpDocumentor 1.4.3