AlarmRecipient Property

This property contains the email address of the person to be alerted when this alarm is triggered.

Object Oriented Interface

public function getAlarmRecipient($alarmindex);
public function setAlarmRecipient($alarmindex, $value);

Procedural Interface

ipworks_caldav_get($res, 7 , $alarmindex);
ipworks_caldav_set($res, 7, $value , $alarmindex);

Default Value

''

Remarks

This property contains the email address of the person to be alerted when this alarm is triggered. If AlarmAction is set to aEmail this property must contain one or more comma-separated email addresses to which the email alarm is to be sent. For instance:

  CalDAV.Alarm.Action = aEmail;
  CalDAV.Alarm.Recipient = "mailto:john_doe@example.com";
  CalDAV.Alarm.Message = "A draft agenda needs to be sent out to the attendees to the weekly managers meeting (MGR-LIST).";
  CalDAV.Alarm.Subject = "REMINDER: Send agenda for weekly staff meeting.";
AlarmRecipient is not used for the aAudio or aDisplay alarm AlarmActions.

The $alarmindex parameter specifies the index of the item in the array. The size of the array is controlled by the AlarmCount property.

This property is not available at design time.

Data Type

String

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks 2020 PHP Edition - Version 20.0 [Build 8307]