PHP Interface Swift_Mime_MimeEntity, Halite

Author: Chris Corbyn

Inheritance: extends Swift_Mime_CharsetObserver, extends Swift_Mime_EncodingObserver

Show file Open project: HaliteChallenge/Halite Interface Usage Examples

Public Methods

Method	Description
getBody ( ) : string \| null	Get the body content of this entity as a string.
getChildren ( ) : Swift_Mime_MimeEntity[]	Get all children nested inside this entity.
getContentType ( ) : string	Get the qualified content-type of this mime entity.
getHeaders ( ) : Swift_Mime_HeaderSet	Get the collection of Headers in this Mime entity.
getId ( ) : string	Returns a unique ID for this entity.
getNestingLevel ( ) : integer	Get the level at which this entity shall be nested in final document.
setBody ( string $body, string $contentType = null )	Set the body content of this entity as a string.
setChildren ( array $children )	Set all children nested inside this entity.
toByteStream ( Swift_InputByteStream $is )	Get this entire entity as a ByteStream.
toString ( ) : string	Get this entire entity in its string form.

Method Details

getBody() public method

Returns NULL if no body has been set.

public getBody ( ) : string \| null
return	string \| null

getChildren() public method

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

public getChildren ( ) : Swift_Mime_MimeEntity[]
return	Swift_Mime_MimeEntity[]

getContentType() public method

Get the qualified content-type of this mime entity.

public getContentType ( ) : string
return	string

getHeaders() public method

Get the collection of Headers in this Mime entity.

public getHeaders ( ) : Swift_Mime_HeaderSet
return	Swift_Mime_HeaderSet

getId() public method

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.

public getId ( ) : string
return	string

getNestingLevel() public method

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

public getNestingLevel ( ) : integer
return	integer

setBody() public method

Set the body content of this entity as a string.

public setBody ( string $body, string $contentType = null )
$body	string
$contentType	string	optional

setChildren() public method

This includes grandchildren.

public setChildren ( array $children )
$children	array

toByteStream() public method

Get this entire entity as a ByteStream.

public toByteStream ( Swift_InputByteStream $is )
$is	Swift_InputByteStream	to write to

toString() public method

Get this entire entity in its string form.

public toString ( ) : string
return	string