Docs For Class Swift_Mime

method getBody [line 87]

string getBody(
)

Get the body content of this entity as a string.

Returns NULL if no body has been set.

Tags:

access:

public

[ Top ]

method getChildren [line 67]

Swift_Mime_MimeEntity[] getChildren(
)

Get all children nested inside this entity.

These are not just the immediate children, but all children.

Tags:

access:

public

[ Top ]

method getContentType [line 49]

string getContentType(
)

Get the qualified content-type of this mime entity.

Tags:

access:

public

[ Top ]

method getHeaders [line 80]

Swift_Mime_Header[] getHeaders(
)

Get the collection of Headers in this Mime entity.

Tags:

access:

public

[ Top ]

method getId [line 60]

string getId(
)

Returns a unique ID for this entity.

For most entities this will likely be the Content-ID, though it has no explicit semantic meaning and can be considered an identifier for programming logic purposes. If a Content-ID header is present, this value SHOULD match the value of the header.

Tags:

access:

public

[ Top ]

method getNestingLevel [line 43]

int getNestingLevel(
)

Get the level at which this entity shall be nested in final document.

The lower the value, the more outermost the entity will be nested.

Tags:

see:	Swift_Mime_MimeEntity::LEVEL_TOP, Swift_Mime_MimeEntity::LEVEL_MIXED, Swift_Mime_MimeEntity::LEVEL_RELATED, Swift_Mime_MimeEntity::LEVEL_ALTERNATIVE
access:	public

[ Top ]

method setBody [line 94]

void setBody(
string
$body, [string
$contentType = null])

Set the body content of this entity as a string.

Tags:

access:

public

Parameters:

string	$body
string	$contentType	optional

[ Top ]

method setChildren [line 74]

void setChildren(

$children)

Set all children nested inside this entity.

This includes grandchildren.

Tags:

access:

public

Parameters:

Swift_Mime_MimeEntity[]

$children

[ Top ]

method toByteStream [line 106]

void toByteStream(
Swift_InputByteStream
$is)

Get this entire entity as a ByteStream.

Tags:

access:

public

Parameters:

Swift_InputByteStream

$is

to write to

[ Top ]

method toString [line 100]

string toString(
)

Get this entire entity in its string form.

Tags:

access:

public

[ Top ]

LEVEL_ALTERNATIVE = 4096

[line 32]

An entity which nests with the same precedence as a mime part

[ Top ]

LEVEL_MIXED = 256

[line 29]

An entity which nests with the same precedence as an attachment

[ Top ]

LEVEL_RELATED = 65536

[line 35]

An entity which nests with the same precedence as embedded content

[ Top ]

LEVEL_TOP = 16

[line 26]

Main message document; there can only be one of these

[ Top ]

Class: Swift_Mime_MimeEntity

Interface Overview

Author(s):

Constants

Methods

Child classes:

Inherited Methods

Class: Swift_Mime_CharsetObserver

Class Details

Tags:

Class Methods

method getBody [line 87]

Tags:

method getChildren [line 67]

Tags:

method getContentType [line 49]

Tags:

method getHeaders [line 80]

Tags:

method getId [line 60]

Tags:

method getNestingLevel [line 43]

Tags:

method setBody [line 94]

Tags:

Parameters:

method setChildren [line 74]

Tags:

Parameters:

method toByteStream [line 106]

Tags:

Parameters:

method toString [line 100]

Tags:

Class Constants

LEVEL_ALTERNATIVE = 4096

LEVEL_MIXED = 256

LEVEL_RELATED = 65536

LEVEL_TOP = 16