API Documentation
\

\Horde_Compress_Tnef_VTodo

Object to parse and represent vTODO data encapsulated in a TNEF file.

Summary

Methods
Properties
Constants
__construct()
setTnefAttribute()
setMapiAttribute()
toArray()
__get()
$type
MAPI_TASK_STATUS
MAPI_TASK_PERCENTCOMPLETE
MAPI_TASK_STARTDATE
MAPI_TASK_DUEDATE
MAPI_TASK_NODUEDATE
MAPI_TASK_COMMONEND
MAPI_TASK_COMMONSTART
MAPI_TASK_ACCEPTED
MAPI_TASK_DATECOMPLETED
MAPI_TASK_STATE
MAPI_TASK_ASSIGNERS
MAPI_TASK_UPDATES
MAPI_TASK_OWNER
MAPI_TASK_ASSIGNER
MAPI_TASK_LASTUSER
MAPI_TASK_OWNERSHIP
STATUS_NOT_STARTED
STATUS_IN_PROGRESS
STATUS_COMPLETE
STATUS_WAIT
STATUS_DEFERRED
STATE_TASK_NOT_FOUND
STATE_NOT_ASSIGNED
STATE_ASSIGNEE_COPY
STATE_ASSIGNERS_COPY
STATE_ASSIGNERS_REJECTED
OWNERSHIP_NONE
OWNERSHIP_ASSIGNERS_COPY
OWNERSHIP_ASSIGNEES_COPY
CLASS_REQUEST
CLASS_ACCEPT
CLASS_DECLINE
CLASS_UPDATE
TASK_STATUS_ACTION
TASK_STATUS_IN_PROGRESS
TASK_STATUS_COMPLETED
_getx()
_geti()
_tovTodo()
$_logger
$_data
$_options
$_due
$_guid
$_msgformat
$_percentComplete
$_bodyPlain
$_bodyHtml
$_rtfCompressed
$_updates
$_state
$_ownership
$_method
$_messageClass
$_owner
$_lastUser
$_start
$_status
$_completed
N/A
No private methods found
No private properties found
N/A

Constants

MAPI_TASK_STATUS

MAPI_TASK_STATUS

MAPI_TASK_PERCENTCOMPLETE

MAPI_TASK_PERCENTCOMPLETE

MAPI_TASK_STARTDATE

MAPI_TASK_STARTDATE

MAPI_TASK_DUEDATE

MAPI_TASK_DUEDATE

MAPI_TASK_NODUEDATE

MAPI_TASK_NODUEDATE

MAPI_TASK_COMMONEND

MAPI_TASK_COMMONEND

MAPI_TASK_COMMONSTART

MAPI_TASK_COMMONSTART

MAPI_TASK_ACCEPTED

MAPI_TASK_ACCEPTED

MAPI_TASK_DATECOMPLETED

MAPI_TASK_DATECOMPLETED

MAPI_TASK_STATE

MAPI_TASK_STATE

MAPI_TASK_ASSIGNERS

MAPI_TASK_ASSIGNERS

MAPI_TASK_UPDATES

MAPI_TASK_UPDATES

MAPI_TASK_OWNER

MAPI_TASK_OWNER

MAPI_TASK_ASSIGNER

MAPI_TASK_ASSIGNER

MAPI_TASK_LASTUSER

MAPI_TASK_LASTUSER

MAPI_TASK_OWNERSHIP

MAPI_TASK_OWNERSHIP

STATUS_NOT_STARTED

STATUS_NOT_STARTED

MAPI_TASK_STATUS constants

STATUS_IN_PROGRESS

STATUS_IN_PROGRESS

STATUS_COMPLETE

STATUS_COMPLETE

STATUS_WAIT

STATUS_WAIT

STATUS_DEFERRED

STATUS_DEFERRED

STATE_TASK_NOT_FOUND

STATE_TASK_NOT_FOUND

MAPI_TASK_STATE constants

STATE_NOT_ASSIGNED

STATE_NOT_ASSIGNED

STATE_ASSIGNEE_COPY

STATE_ASSIGNEE_COPY

STATE_ASSIGNERS_COPY

STATE_ASSIGNERS_COPY

STATE_ASSIGNERS_REJECTED

STATE_ASSIGNERS_REJECTED

OWNERSHIP_NONE

OWNERSHIP_NONE

MAPI_TASK_OWNERSHIP

OWNERSHIP_ASSIGNERS_COPY

OWNERSHIP_ASSIGNERS_COPY

OWNERSHIP_ASSIGNEES_COPY

OWNERSHIP_ASSIGNEES_COPY

CLASS_REQUEST

CLASS_REQUEST

MAPI_MESSAGE_CLASS

CLASS_ACCEPT

CLASS_ACCEPT

CLASS_DECLINE

CLASS_DECLINE

CLASS_UPDATE

CLASS_UPDATE

TASK_STATUS_ACTION

TASK_STATUS_ACTION

TASK_STATUS_IN_PROGRESS

TASK_STATUS_IN_PROGRESS

TASK_STATUS_COMPLETED

TASK_STATUS_COMPLETED

Properties

$type

$type : string

The MIME type of this object's content.

Type

string

$_logger

$_logger : \Horde_Log_Logger

Type

\Horde_Log_Logger

$_data

$_data : string

Type

string

$_options

$_options : array

Type

array

$_due

$_due : \integer.

Due date (timestamp).

Type

\integer.

$_guid

$_guid : string

UID

Type

string

$_msgformat

$_msgformat : integer

Type

integer

$_percentComplete

$_percentComplete : integer

Percentage of task that is completed.

Type

integer

$_bodyPlain

$_bodyPlain : string

Plain body

Type

string

$_bodyHtml

$_bodyHtml : string

HTML body.

Type

string

$_rtfCompressed

$_rtfCompressed : string

Compressed RTF body.

Type

string

$_updates

$_updates : boolean

If true, assignee is requested to send updates.

Type

boolean

$_state

$_state : \integer.

The MAPI_TASK_STATE value. Used to help determine METHOD.

Type

\integer.

$_ownership

$_ownership : integer

The MAPI_TASK_OWNERSHIP value.

Type

integer

$_method

$_method : string

The METHOD to use in the generated vTodo component. Default to REQUEST since TNEF files are generally not used for PUBLISH.

Type

string

$_messageClass

$_messageClass : string

The MAPI_MESSAGE_CLASS

Type

string

$_owner

$_owner : string

The current owner of the task. Note, this is the CURRENT owner, so for the initial REQUEST, this will be empty. MS doesn't consider the task creator the owner in this context.

Type

string

$_lastUser

$_lastUser : string

Last user to modify the request.

Type

string

$_start

$_start : integer

Start time of task.

Type

integer

$_status

$_status : string

Status of task.

Type

string

$_completed

$_completed : integer

Timestamp when task was completed.

Type

integer

Methods

__construct()

__construct(  $logger,   $data = null,   $options = array())

Parameters

$logger
$data
$options

setTnefAttribute()

setTnefAttribute(integer  $attribute, mixed  $value, integer  $size)

Allow this object to set any TNEF attributes it needs to know about, ignore any it doesn't care about.

Parameters

integer $attribute

The attribute descriptor.
mixed $value

The value from the MAPI stream.
integer $size

The byte length of the data, as reported by the MAPI data.

setMapiAttribute()

setMapiAttribute(integer  $type, integer  $name,   $value,   $ns = null)

Allow this object to set any MAPI attributes it needs to know about, ignore any it doesn't care about.

Parameters

integer $type

The attribute type descriptor.
integer $name

The attribute name descriptor.
$value
$ns

toArray()

toArray() : array

Output the data for this object in an array.

Returns

array —
  • type: (string) The MIME type of the content.
    • subtype: (string) The MIME subtype.
    • name: (string) The filename.
    • stream: (string) The file data.

__get()

__get(  $property)

Parameters

$property

_getx()

_getx(  $data, integer  $bytes) : string

Pop specified number of bytes from the buffer.

Parameters

$data
integer $bytes

How many bytes to retrieve.

Returns

string —

The specified number of bytes from $data.

_geti()

_geti(  $data, integer  $bits) : integer

Pop specified number of bits from the buffer

Parameters

$data
integer $bits

How many bits to retrieve.

Returns

integer —

The value from $data.

_tovTodo()

_tovTodo()