PHP Class Horde_ActiveSync_Rfc822, horde

Author: Michael J Rubinsky ([email protected])

Show file Open project: horde/horde Class Usage Examples

Public Properties

Property	Type	Description
$memoryLimit	integer	The memory limit for use with the PHP temp stream.

Protected Properties

Property	Type	Description
$_eol	integer	The size of the EOL sequence.
$_hdr_pos	integer	Position of end of headers.
$_header_text	string	The header text.
$_stream	Horde_Stream	The raw message data in a stream.

Public Methods

Method	Description
__construct ( mixed $rfc822, boolean $auto_add_headers = true )	Constructor.
addStandardHeaders ( )	Check for and add standard headers if needed.
getBytes ( ) : integer	Return the length of the message data.
getHeaders ( ) : Horde_Mime_Headers	Return the message headers.
getMessage ( ) : Horde_Stream	Returns the raw message with the message headers stripped.
getMimeObject ( ) : Horde_Mime_Part	Return a Mime object representing the entire message.
getString ( ) : stream	Return the raw message data.
replaceMime ( Horde_Mime_Part $part )	Replace the MIME part of the message sent from the client. Headers from the original message are always used.

Protected Methods

Method	Description
_findHeader ( ) : array	Find the location of the end of the header text.
_parseStream ( Horde_Stream $stream )	Parse a Horde_Stream object to get the header and eol data.

Method Details

__construct() public method

Constructor.

public __construct ( mixed $rfc822, boolean $auto_add_headers = true )
$rfc822	mixed	The incoming message. Either a string or a stream resource.
$auto_add_headers	boolean	Automatically add the standard Message-ID and User-Agent headers? @since 2.14.0

_findHeader() protected method

Find the location of the end of the header text.

protected _findHeader ( ) : array
return	array	1st element: Header position, 2nd element: Length of trailing EOL.

_parseStream() protected method

Parse a Horde_Stream object to get the header and eol data.

protected _parseStream ( Horde_Stream $stream )
$stream	Horde_Stream	The stream object.

addStandardHeaders() public method

Check for and add standard headers if needed.

Since: 2.14.0

public addStandardHeaders ( )

getBytes() public method

Return the length of the message data.

public getBytes ( ) : integer
return	integer

getHeaders() public method

Return the message headers.

public getHeaders ( ) : Horde_Mime_Headers
return	Horde_Mime_Headers	The header object.

getMessage() public method

Returns the raw message with the message headers stripped.

public getMessage ( ) : Horde_Stream
return	Horde_Stream

getMimeObject() public method

Return a Mime object representing the entire message.

public getMimeObject ( ) : Horde_Mime_Part
return	Horde_Mime_Part	The Mime object.

getString() public method

Return the raw message data.

public getString ( ) : stream
return	stream	resource

replaceMime() public method

Replace the MIME part of the message sent from the client. Headers from the original message are always used.

Since: 2.19.0

public replaceMime ( Horde_Mime_Part $part )
$part	Horde_Mime_Part	The new MIME part.

Property Details

$_eol protected property

The size of the EOL sequence.

protected int $_eol
return	integer

$_hdr_pos protected property

Position of end of headers.

protected int $_hdr_pos
return	integer

$_header_text protected property

The header text.

protected string $_header_text
return	string

$_stream protected property

The raw message data in a stream.

protected Horde_Stream $_stream
return	Horde_Stream

$memoryLimit public static property

The memory limit for use with the PHP temp stream.

public static int $memoryLimit
return	integer