You are here: Home // ICAP Functions
icap_list_alarms
(PHP4 >= 4.0b4)
icap_list_alarms – Return a list of events that has an alarm triggered at the given datetime
Description
int icap_list_alarms (int stream_id, array date, array time)
Returns an array of event ID’s that has an alarm going off at the given datetime.
Icap_list_alarms() function takes in a datetime for a calendar stream. An array of
icap_snooze
(PHP4 >= 4.0b4)
icap_snooze – Snooze an alarm
Description
string icap_snooze (int stream_id, int uid)
Icap_snooze() turns on an alarm for a calendar event specified by the uid.
Returns true.
icap_delete_event
(PHP4 >= 4.0b4)
icap_delete_event – Delete an event from an ICAP calendar
Description
string icap_delete_event (int sream_id, int uid)
Icap_delete_event() deletes the calendar event specified by the uid.
Returns true.
icap_store_event
(PHP4 >= 4.0b4)
icap_store_event – Store an event into an ICAP calendar
Description
string icap_store_event (int stream_id, object event)
Icap_store_event() Stores an event into an ICAP calendar. An event object consists of:
int public – 1 if public, 0 if private;
string caegory – Category string of the event.
string title – Title string of the event.
string description
icap_list_events
(PHP4 >= 4.0RC1)
icap_list_events – Return a list of events between two given datetimes
Description
array icap_list_events (int stream_id, int begin_date [, int end_date])
Returns an array of event ID’s that are between the two given datetimes.
Icap_list_events() function takes in a beginning datetime and an end datetime for a calendar stream. An
icap_fetch_event
(PHP4 >= 4.0b4)
icap_fetch_event – Fetches an event from the calendar stream/
Description
int icap_fetch_event (int stream_id, int event_id [, int options])
Icap_fetch_event() fetches an event from the calendar stream specified by event_id.
Returns an event object consisting of:
int id – ID of that event.
int public – TRUE if the event if public, FALSE if it
icap_close
(unknown)
icap_close – Close an ICAP stream
Description
int icap_close (int icap_stream [, int flags])
Closes the given icap stream.
icap_open
(PHP4 >= 4.0b4)
icap_open – Opens up an ICAP connection
Description
stream icap_open (string calendar, string username, string password, string options)
Returns an ICAP stream on success, false on error.
icap_open() opens up an ICAP connection to the specified calendar store. If the optional options is specified, passes the options to that mailbox also.















































