• Home
  • Horde_Compress_Tnef

PHP Class Horde_Compress_Tnef, horde

The TNEF rendering is based on code by: Graham Norbury Original design by: Thomas Boll , Mark Simpson Copyright 2002-2016 Horde LLC (http://www.horde.org/) See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.
Author: Jan Schneider ([email protected])
Author: Michael Slusarz ([email protected])
Author: Michael J Rubinsky ([email protected])
Inheritance: extends Horde_Compress_Base
Mostra file Open project: horde/horde Class Usage Examples

Public Properties

Property Type Description
$canDecompress

Protected Properties

Property Type Description
$_attachments Collection of embedded TNEF attachments within the outer TNEF file.
$_currentObject Horde_Compress_Tnef_Object The TNEF object currently being decoded.
$_files Collection of files contained in the TNEF data.
$_msgInfo Horde_Compress_Tnef_MessageData

Public Methods

Method Description
decompress ( $data, array $params = [] ) : array Decompress the TNEF data. For BC reasons we can only return a numerically indexed array of object data. For more detailed information, use self::getFiles(), self::getAttachements(), and self::getMsgInfo().
getAttachments ( ) : array Return the collection of embedded attachments.
getFiles ( ) : array Return the collection of files in the TNEF data.
getMsgInfo ( ) : array Return the message information data.
setCurrentObject ( Horde_Compress_Tnef_Object $object ) Sets the current object being decompressed.

Protected Methods

Method Description
_decodeAttachment ( &$data ) : [type] Decodes all LVL_ATTACHMENT data. Attachment data MUST be at the end of TNEF stream. First LVL_ATTACHMENT MUST be ARENDDATA (attAttachRendData).
_decodeAttribute ( &$data ) Decode a single attribute.
_decodeMessageProperty ( &$data ) : [type] Decodes TNEF attributes.
_extractMapiAttributes ( string $data ) Extract a set of encapsulated MAPI properties. Normally either embedded in an attachment structure, or an idMessageProperty structure.
_geti ( &$data, integer $bits ) : TODO Pop specified number of bits from the buffer
_getx ( &$data, integer $bytes ) Pop specified number of bytes from the buffer.
_toNamespaceGUID ( $value )

Method Details

_decodeAttachment() protected method

From MS-OXTNEF: ; An attachment is determined/delimited by attAttachRendData, followed by ; other encoded attributes, if any, and ending with attAttachment ; if there are any encoded properties. AttachData = AttachRendData [*AttachAttribute] [AttachProps] AttachRendData = attrLevelAttachment idAttachRendData Length Data Checksum AttachAttribute = attrLevelAttachment idAttachAttr Length Data Checksum AttachProps = attrLevelAttachment idAttachment Length Data Checksum
protected _decodeAttachment ( &$data ) : [type]
return [type]

_decodeAttribute() protected method

Decode a single attribute.
protected _decodeAttribute ( &$data )

_decodeMessageProperty() protected method

Decodes TNEF attributes.
protected _decodeMessageProperty ( &$data ) : [type]
return [type]

_extractMapiAttributes() protected method

Extract a set of encapsulated MAPI properties. Normally either embedded in an attachment structure, or an idMessageProperty structure.
protected _extractMapiAttributes ( string $data )
$data string The data string.

_geti() protected method

Pop specified number of bits from the buffer
protected _geti ( &$data, integer $bits ) : TODO
$bits integer How many bits to retrieve.
return TODO

_getx() protected method

Pop specified number of bytes from the buffer.
protected _getx ( &$data, integer $bytes )
$bytes integer How many bytes to retrieve.

_toNamespaceGUID() protected method

protected _toNamespaceGUID ( $value )

decompress() public method

Decompress the TNEF data. For BC reasons we can only return a numerically indexed array of object data. For more detailed information, use self::getFiles(), self::getAttachements(), and self::getMsgInfo().
public decompress ( $data, array $params = [] ) : array
$params array
return array The decompressed data.

getAttachments() public method

Return the collection of embedded attachments.
public getAttachments ( ) : array
return array @see self::$_attachments

getFiles() public method

Return the collection of files in the TNEF data.
public getFiles ( ) : array
return array @see self::$_files

getMsgInfo() public method

Return the message information data.
public getMsgInfo ( ) : array
return array @see self::$_msgInfo

setCurrentObject() public method

Sets the current object being decompressed.
public setCurrentObject ( Horde_Compress_Tnef_Object $object )
$object Horde_Compress_Tnef_Object

Property Details

$_attachments protected_oe property

Collection of embedded TNEF attachments within the outer TNEF file.
protected $_attachments

$_currentObject protected_oe property

The TNEF object currently being decoded.
protected Horde_Compress_Tnef_Object $_currentObject
return Horde_Compress_Tnef_Object

$_files protected_oe property

Collection of files contained in the TNEF data.
protected $_files

$_msgInfo protected_oe property

protected Horde_Compress_Tnef_MessageData $_msgInfo
return Horde_Compress_Tnef_MessageData

$canDecompress public_oe property

public $canDecompress