Documentation

Horde_Compress_Tnef_VTodo extends Horde_Compress_Tnef_Object
in package

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

Tags
author

Michael J Rubinsky mrubinsk@horde.org

category

Horde

copyright

2002-2017 Horde LLC

license

http://www.horde.org/licenses/lgpl21 LGPL 2.1

Table of Contents

CLASS_ACCEPT  = 'IPM.TaskRequest.Accept'
CLASS_DECLINE  = 'IPM.TaskRequest.Decline'
CLASS_REQUEST  = 'IPM.TaskRequest'
MAPI_MESSAGE_CLASS
CLASS_UPDATE  = 'IPM.TaskRequest.Update'
MAPI_TASK_ACCEPTED  = 0x8108
MAPI_TASK_ASSIGNER  = 0x8121
MAPI_TASK_ASSIGNERS  = 0x8117
MAPI_TASK_COMMONEND  = 0x8517
MAPI_TASK_COMMONSTART  = 0x8516
MAPI_TASK_DATECOMPLETED  = 0x810f
MAPI_TASK_DUEDATE  = 0x8105
MAPI_TASK_LASTUSER  = 0x8122
MAPI_TASK_NODUEDATE  = 0x5ae980e0
MAPI_TASK_OWNER  = 0x811f
MAPI_TASK_OWNERSHIP  = 0x8129
MAPI_TASK_PERCENTCOMPLETE  = 0x8102
MAPI_TASK_STARTDATE  = 0x8104
MAPI_TASK_STATE  = 0x8113
MAPI_TASK_STATUS  = 0x8101
MAPI_TASK_UPDATES  = 0x811b
OWNERSHIP_ASSIGNEES_COPY  = 0x2
OWNERSHIP_ASSIGNERS_COPY  = 0x1
OWNERSHIP_NONE  = 0x0
MAPI_TASK_OWNERSHIP
STATE_ASSIGNEE_COPY  = 0x2
STATE_ASSIGNERS_COPY  = 0x3
STATE_ASSIGNERS_REJECTED  = 0x4
STATE_NOT_ASSIGNED  = 0x1
STATE_TASK_NOT_FOUND  = 0x0
MAPI_TASK_STATE constants
STATUS_COMPLETE  = 0x2
STATUS_DEFERRED  = 0x4
STATUS_IN_PROGRESS  = 0x1
STATUS_NOT_STARTED  = 0x0
MAPI_TASK_STATUS constants
STATUS_WAIT  = 0x3
TASK_STATUS_ACTION  = 'NEEDS-ACTION'
TASK_STATUS_COMPLETED  = 'COMPLETED'
TASK_STATUS_IN_PROGRESS  = 'IN-PROGRESS'
$type  : string
The MIME type of this object's content.
$_bodyHtml  : string
HTML body.
$_bodyPlain  : string
Plain body
$_completed  : int
Timestamp when task was completed.
$_data  : string
$_due  : mixed
Due date (timestamp).
$_guid  : string
UID
$_lastUser  : string
Last user to modify the request.
$_logger  : Horde_Log_Logger
$_messageClass  : string
The MAPI_MESSAGE_CLASS
$_method  : string
The METHOD to use in the generated vTodo component. Default to REQUEST since TNEF files are generally not used for PUBLISH.
$_msgformat  : int
$_options  : array<string|int, mixed>
$_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.
$_ownership  : int
The MAPI_TASK_OWNERSHIP value.
$_percentComplete  : int
Percentage of task that is completed.
$_rtfCompressed  : string
Compressed RTF body.
$_start  : int
Start time of task.
$_state  : mixed
The MAPI_TASK_STATE value. Used to help determine METHOD.
$_status  : string
Status of task.
$_updates  : bool
If true, assignee is requested to send updates.
__construct()  : mixed
__get()  : mixed
setMapiAttribute()  : mixed
Allow this object to set any MAPI attributes it needs to know about, ignore any it doesn't care about.
setTnefAttribute()  : mixed
Allow this object to set any TNEF attributes it needs to know about, ignore any it doesn't care about.
toArray()  : array<string|int, mixed>
Output the data for this object in an array.
_geti()  : int
Pop specified number of bits from the buffer
_getx()  : string
Pop specified number of bytes from the buffer.
_tovTodo()  : mixed

Constants

CLASS_ACCEPT

public mixed CLASS_ACCEPT = 'IPM.TaskRequest.Accept'

CLASS_DECLINE

public mixed CLASS_DECLINE = 'IPM.TaskRequest.Decline'

CLASS_REQUEST

MAPI_MESSAGE_CLASS

public mixed CLASS_REQUEST = 'IPM.TaskRequest'

CLASS_UPDATE

public mixed CLASS_UPDATE = 'IPM.TaskRequest.Update'

MAPI_TASK_ACCEPTED

public mixed MAPI_TASK_ACCEPTED = 0x8108

MAPI_TASK_ASSIGNER

public mixed MAPI_TASK_ASSIGNER = 0x8121

MAPI_TASK_ASSIGNERS

public mixed MAPI_TASK_ASSIGNERS = 0x8117

MAPI_TASK_COMMONEND

public mixed MAPI_TASK_COMMONEND = 0x8517

MAPI_TASK_COMMONSTART

public mixed MAPI_TASK_COMMONSTART = 0x8516

MAPI_TASK_DATECOMPLETED

public mixed MAPI_TASK_DATECOMPLETED = 0x810f

MAPI_TASK_DUEDATE

public mixed MAPI_TASK_DUEDATE = 0x8105

MAPI_TASK_LASTUSER

public mixed MAPI_TASK_LASTUSER = 0x8122

MAPI_TASK_NODUEDATE

public mixed MAPI_TASK_NODUEDATE = 0x5ae980e0

MAPI_TASK_OWNER

public mixed MAPI_TASK_OWNER = 0x811f

MAPI_TASK_OWNERSHIP

public mixed MAPI_TASK_OWNERSHIP = 0x8129

MAPI_TASK_PERCENTCOMPLETE

public mixed MAPI_TASK_PERCENTCOMPLETE = 0x8102

MAPI_TASK_STARTDATE

public mixed MAPI_TASK_STARTDATE = 0x8104

MAPI_TASK_STATE

public mixed MAPI_TASK_STATE = 0x8113

MAPI_TASK_STATUS

public mixed MAPI_TASK_STATUS = 0x8101

MAPI_TASK_UPDATES

public mixed MAPI_TASK_UPDATES = 0x811b

OWNERSHIP_ASSIGNEES_COPY

public mixed OWNERSHIP_ASSIGNEES_COPY = 0x2

OWNERSHIP_ASSIGNERS_COPY

public mixed OWNERSHIP_ASSIGNERS_COPY = 0x1

OWNERSHIP_NONE

MAPI_TASK_OWNERSHIP

public mixed OWNERSHIP_NONE = 0x0

STATE_ASSIGNEE_COPY

public mixed STATE_ASSIGNEE_COPY = 0x2

STATE_ASSIGNERS_COPY

public mixed STATE_ASSIGNERS_COPY = 0x3

STATE_ASSIGNERS_REJECTED

public mixed STATE_ASSIGNERS_REJECTED = 0x4

STATE_NOT_ASSIGNED

public mixed STATE_NOT_ASSIGNED = 0x1

STATE_TASK_NOT_FOUND

MAPI_TASK_STATE constants

public mixed STATE_TASK_NOT_FOUND = 0x0

STATUS_COMPLETE

public mixed STATUS_COMPLETE = 0x2

STATUS_DEFERRED

public mixed STATUS_DEFERRED = 0x4

STATUS_IN_PROGRESS

public mixed STATUS_IN_PROGRESS = 0x1

STATUS_NOT_STARTED

MAPI_TASK_STATUS constants

public mixed STATUS_NOT_STARTED = 0x0

STATUS_WAIT

public mixed STATUS_WAIT = 0x3

TASK_STATUS_ACTION

public mixed TASK_STATUS_ACTION = 'NEEDS-ACTION'

TASK_STATUS_COMPLETED

public mixed TASK_STATUS_COMPLETED = 'COMPLETED'

TASK_STATUS_IN_PROGRESS

public mixed TASK_STATUS_IN_PROGRESS = 'IN-PROGRESS'

Properties

$type

The MIME type of this object's content.

public string $type = 'text/calendar'

$_bodyHtml

HTML body.

protected string $_bodyHtml

$_bodyPlain

Plain body

protected string $_bodyPlain

$_completed

Timestamp when task was completed.

protected int $_completed

$_due

Due date (timestamp).

protected mixed $_due

integer.

$_guid

UID

protected string $_guid

$_lastUser

Last user to modify the request.

protected string $_lastUser

$_logger

protected Horde_Log_Logger $_logger

$_messageClass

The MAPI_MESSAGE_CLASS

protected string $_messageClass

$_method

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

protected string $_method = 'REQUEST'

$_msgformat

protected int $_msgformat

$_options

protected array<string|int, mixed> $_options

$_owner

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.

protected string $_owner

$_ownership

The MAPI_TASK_OWNERSHIP value.

protected int $_ownership

$_percentComplete

Percentage of task that is completed.

protected int $_percentComplete

$_rtfCompressed

Compressed RTF body.

protected string $_rtfCompressed

$_start

Start time of task.

protected int $_start

$_state

The MAPI_TASK_STATE value. Used to help determine METHOD.

protected mixed $_state

integer.

$_status

Status of task.

protected string $_status

$_updates

If true, assignee is requested to send updates.

protected bool $_updates = \false

Methods

__construct()

public __construct(mixed $logger[, mixed $data = null ][, mixed $options = array() ]) : mixed
Parameters
$logger : mixed
$data : mixed = null
$options : mixed = array()
Return values
mixed —

__get()

public __get(mixed $property) : mixed
Parameters
$property : mixed
Return values
mixed —

setMapiAttribute()

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

public setMapiAttribute(int $type, int $name, mixed $value[, mixed $ns = null ]) : mixed
Parameters
$type : int

The attribute type descriptor.

$name : int

The attribute name descriptor.

$value : mixed
$ns : mixed = null
Return values
mixed —

setTnefAttribute()

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

public setTnefAttribute(int $attribute, mixed $value, int $size) : mixed
Parameters
$attribute : int

The attribute descriptor.

$value : mixed

The value from the MAPI stream.

$size : int

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

Return values
mixed —

toArray()

Output the data for this object in an array.

public toArray() : array<string|int, mixed>
Return values
array<string|int, mixed> —
  • type: (string) The MIME type of the content.
  • subtype: (string) The MIME subtype.
  • name: (string) The filename.
  • stream: (string) The file data.

_geti()

Pop specified number of bits from the buffer

protected _geti(string &$data, int $bits) : int
Parameters
$data : string

The data string.

$bits : int

How many bits to retrieve.

Return values
int —

The value from $data.

_getx()

Pop specified number of bytes from the buffer.

protected _getx(string &$data, int $bytes) : string
Parameters
$data : string

The data string.

$bytes : int

How many bytes to retrieve.

Return values
string —

The specified number of bytes from $data.

_tovTodo()

protected _tovTodo() : mixed
Return values
mixed —

Search results