Skip to content

Sabre VObject ITip Message

Evert Pot edited this page Sep 1, 2014 · 2 revisions

Sabre\VObject\ITip\Message

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.

  • Class name: Message
  • Namespace: Sabre\VObject\ITip

Properties

$uid

public string $uid

The object's UID

  • Visibility: public

$component

public string $component

The component type, such as VEVENT

  • Visibility: public

$method

public string $method

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

  • Visibility: public

$sequence

public integer $sequence

The current sequence number for the event.

  • Visibility: public

$sender

public string $sender

The senders' email address.

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.

  • Visibility: public

$senderName

public string $senderName

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

  • Visibility: public

$recipient

public string $recipient

The recipient's email address.

  • Visibility: public

$recipientName

public string $recipientName

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

  • Visibility: public

$scheduleStatus

public string $scheduleStatus

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

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

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

  • Visibility: public

$message

public \Sabre\VObject\Component\VCalendar $message

The iCalendar / iTip body.

  • Visibility: public

Methods

getScheduleStatus

mixed Sabre\VObject\ITip\Message::getScheduleStatus()

Returns the schedule status as an array: [ 0 => '1.2', 1 => 'Delivered', ]

  • Visibility: public
Clone this wiki locally