PHP Class Swift_Mime_MimePart, Halite

Author: Chris Corbyn

Inheritance: extends Swift_Mime_SimpleMimeEntity

Show file Open project: HaliteChallenge/Halite Class Usage Examples

Protected Properties

Property	Type	Description
$_userCharset		The charset last specified by the user
$_userDelSp		The delsp parameter last specified by the user
$_userFormat		The format parameter last specified by the user

Public Methods

Method	Description
__construct ( Swift_Mime_HeaderSet $headers, Swift_Mime_ContentEncoder $encoder, Swift_KeyCache $cache, Swift_Mime_Grammar $grammar, string $charset = null )	Create a new MimePart with $headers, $encoder and $cache.
charsetChanged ( string $charset )	Receive notification that the charset has changed on this document, or a parent document.
getCharset ( ) : string	Get the character set of this entity.
getDelSp ( ) : boolean	Test if delsp is being used for this entity.
getFormat ( ) : string	Get the format of this entity (i.e. flowed or fixed).
getNestingLevel ( ) : integer	Get the nesting level of this entity.
setBody ( mixed $body, string $contentType = null, string $charset = null ) : Swift_Mime_MimePart	Set the body of this entity, either as a string, or as an instance of {@link Swift_OutputByteStream}.
setCharset ( string $charset ) : Swift_Mime_MimePart	Set the character set of this entity.
setDelSp ( boolean $delsp = true ) : Swift_Mime_MimePart	Turn delsp on or off for this entity.
setFormat ( string $format ) : Swift_Mime_MimePart	Set the format of this entity (flowed or fixed).

Protected Methods

Method	Description
_convertString ( $string )	Encode charset when charset is not utf-8
_fixHeaders ( )	Fix the content-type and encoding of this entity
_setNestingLevel ( $level )	Set the nesting level of this entity

Method Details

__construct() public method

Create a new MimePart with $headers, $encoder and $cache.

public __construct ( Swift_Mime_HeaderSet $headers, Swift_Mime_ContentEncoder $encoder, Swift_KeyCache $cache, Swift_Mime_Grammar $grammar, string $charset = null )
$headers	Swift_Mime_HeaderSet
$encoder	Swift_Mime_ContentEncoder
$cache	Swift_KeyCache
$grammar	Swift_Mime_Grammar
$charset	string

_convertString() protected method

Encode charset when charset is not utf-8

protected _convertString ( $string )

_fixHeaders() protected method

Fix the content-type and encoding of this entity

protected _fixHeaders ( )

_setNestingLevel() protected method

Set the nesting level of this entity

protected _setNestingLevel ( $level )

charsetChanged() public method

Receive notification that the charset has changed on this document, or a parent document.

public charsetChanged ( string $charset )
$charset	string

getCharset() public method

Get the character set of this entity.

public getCharset ( ) : string
return	string

getDelSp() public method

Test if delsp is being used for this entity.

public getDelSp ( ) : boolean
return	boolean

getFormat() public method

Get the format of this entity (i.e. flowed or fixed).

public getFormat ( ) : string
return	string

getNestingLevel() public method

Get the nesting level of this entity.

public getNestingLevel ( ) : integer
return	integer

setBody() public method

Set the body of this entity, either as a string, or as an instance of {@link Swift_OutputByteStream}.

public setBody ( mixed $body, string $contentType = null, string $charset = null ) : Swift_Mime_MimePart
$body	mixed
$contentType	string	optional
$charset	string	optional
return	Swift_Mime_MimePart

setCharset() public method

Set the character set of this entity.

public setCharset ( string $charset ) : Swift_Mime_MimePart
$charset	string
return	Swift_Mime_MimePart

setDelSp() public method

Turn delsp on or off for this entity.

public setDelSp ( boolean $delsp = true ) : Swift_Mime_MimePart
$delsp	boolean
return	Swift_Mime_MimePart

setFormat() public method

Set the format of this entity (flowed or fixed).

public setFormat ( string $format ) : Swift_Mime_MimePart
$format	string
return	Swift_Mime_MimePart

Property Details

$_userCharset protected property

The charset last specified by the user

protected $_userCharset

$_userDelSp protected property

The delsp parameter last specified by the user

protected $_userDelSp

$_userFormat protected property

The format parameter last specified by the user

protected $_userFormat