Documentation

Horde_ActiveSync_Rfc822
in package

Horde_ActiveSync_Rfc822:: class provides functionality related to dealing with raw RFC822 message strings within an ActiveSync context.

Tags
license

http://www.horde.org/licenses/gpl GPLv2

copyright

2010-2020 Horde LLC (http://www.horde.org)

author

Michael J Rubinsky mrubinsk@horde.org

Table of Contents

$memoryLimit  : int
The memory limit for use with the PHP temp stream.
$_eol  : int
The size of the EOL sequence.
$_hdr_pos  : int
Position of end of headers.
$_header_text  : string
The header text.
$_stream  : Horde_Stream
The raw message data in a stream.
__construct()  : mixed
Constructor.
addStandardHeaders()  : mixed
Check for and add standard headers if needed.
getBytes()  : int
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()  : mixed
Replace the MIME part of the message sent from the client. Headers from the original message are always used.
_findHeader()  : array<string|int, mixed>
Find the location of the end of the header text.
_parseStream()  : mixed
Parse a Horde_Stream object to get the header and eol data.

Properties

$memoryLimit

The memory limit for use with the PHP temp stream.

public static int $memoryLimit = 2097152

$_eol

The size of the EOL sequence.

protected int $_eol

$_hdr_pos

Position of end of headers.

protected int $_hdr_pos

$_header_text

The header text.

protected string $_header_text

$_stream

The raw message data in a stream.

protected Horde_Stream $_stream

Methods

__construct()

Constructor.

public __construct(mixed $rfc822[, bool $auto_add_headers = true ]) : mixed
Parameters
$rfc822 : mixed

The incoming message. Either a string or a stream resource.

$auto_add_headers : bool = true

Automatically add the standard Message-ID and User-Agent headers? @since 2.14.0

Return values
mixed

addStandardHeaders()

Check for and add standard headers if needed.

public addStandardHeaders() : mixed
Tags
since
2.14.0
Return values
mixed

getBytes()

Return the length of the message data.

public getBytes() : int
Return values
int

getHeaders()

Return the message headers.

public getHeaders() : Horde_Mime_Headers
Return values
Horde_Mime_Headers

The header object.

getMessage()

Returns the raw message with the message headers stripped.

public getMessage() : Horde_Stream
Return values
Horde_Stream

getMimeObject()

Return a Mime object representing the entire message.

public getMimeObject() : Horde_Mime_Part
Return values
Horde_Mime_Part

The Mime object.

getString()

Return the raw message data.

public getString() : stream
Tags
todo

Rename to make it clear this returns a stream.

Return values
stream

resource

replaceMime()

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

public replaceMime(Horde_Mime_Part $part) : mixed
Parameters
$part : Horde_Mime_Part

The new MIME part.

Tags
since
2.19.0
Return values
mixed

_findHeader()

Find the location of the end of the header text.

protected _findHeader() : array<string|int, mixed>
Return values
array<string|int, mixed>

1st element: Header position, 2nd element: Length of trailing EOL.

_parseStream()

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

protected _parseStream(Horde_Stream $stream) : mixed
Parameters
$stream : Horde_Stream

The stream object.

Return values
mixed

Search results