Documentation

Message
in package

This class represents an iTip message.

A message holds all the information relevant to the message, including the object itself.

It should for the most part be treated as immutable.

Tags
copyright

Copyright (C) fruux GmbH (https://fruux.com/)

author

Evert Pot (http://evertpot.com/)

license

http://sabre.io/license/ Modified BSD License

Table of Contents

$component  : string
The component type, such as VEVENT.
$message  : VCalendar
The iCalendar / iTip body.
$method  : string
Contains the ITip method, which is something like REQUEST, REPLY or CANCEL.
$recipient  : string
The recipient's email address.
$recipientName  : string|null
The name of the recipient. This is usually populated with the CN parameter from the ATTENDEE or ORGANIZER property, if it's available.
$scheduleStatus  : string
After the message has been delivered, this should contain a string such as : 1.1;Sent or 1.2;Delivered.
$sender  : string
The senders' email address.
$senderName  : string|null
The name of the sender. This is often populated from a CN parameter from either the ORGANIZER or ATTENDEE, depending on the message.
$sequence  : int
The current sequence number for the event.
$significantChange  : bool
This will be set to true, if the iTip broker considers the change 'significant'.
$uid  : string
The object's UID.
getScheduleStatus()  : mixed
Returns the schedule status as a string.

Properties

$component

The component type, such as VEVENT.

public string $component

$method

Contains the ITip method, which is something like REQUEST, REPLY or CANCEL.

public string $method

$recipient

The recipient's email address.

public string $recipient

$recipientName

The name of the recipient. This is usually populated with the CN parameter from the ATTENDEE or ORGANIZER property, if it's available.

public string|null $recipientName

$scheduleStatus

After the message has been delivered, this should contain a string such as : 1.1;Sent or 1.2;Delivered.

public string $scheduleStatus

In case of a failure, this will hold the error status code.

See: http://tools.ietf.org/html/rfc6638#section-7.3

$sender

The senders' email address.

public string $sender

Note that this does not imply that this has to be used in a From: field if the message is sent by email. It may also be populated in Reply-To: or not at all.

$senderName

The name of the sender. This is often populated from a CN parameter from either the ORGANIZER or ATTENDEE, depending on the message.

public string|null $senderName

$sequence

The current sequence number for the event.

public int $sequence

$significantChange

This will be set to true, if the iTip broker considers the change 'significant'.

public bool $significantChange = true

In practice, this means that we'll only mark it true, if for instance DTSTART changed. This allows systems to only send iTip messages when significant changes happened. This is especially useful for iMip, as normally a ton of messages may be generated for normal calendar use.

To see the list of properties that are considered 'significant', check out Sabre\VObject\ITip\Broker::$significantChangeProperties.

$uid

The object's UID.

public string $uid

Methods

getScheduleStatus()

Returns the schedule status as a string.

public getScheduleStatus() : mixed

For example: 1.2

Return values
mixed —

bool|string

Search results