Calendar handles are internal objects representing Calendars. When a Calendar handle is created, it can be used to retrieve its events within the specified time intervals, to publish new events, to accept, decline, and cancel events, etc.
- This function opens the specified Mailbox as a Calendar. The mailboxName value should be a string. It specifies the Mailbox name.
- If the name does not start with the ~ symbol, the Mailbox is opened in the current Account, if any.
- The current Account (if any) must have the Read/Select access right for the specified Mailbox.
- The function returns a Calendar handle if the Mailbox has been opened successfully and the Calendar is built using its content, otherwise the function returns an error code string.
- the calendarRef value should be a Calendar handle, and the params value should be a dictionary.
- This function retrieves all calendar events falling into the specified time interval.
- The params dictionary should contain the required timeFrom and timeTill elements with the timestamp values, and optional limit and skip number elements, and an optional byAlarm element. These elements have the same meanings as the attributes of the findEvents XIMSS operation.
- If the function fails, it returns an error code string. Otherwise, it returns an array of dictionaries for each 24-hour day (in the selected time zone) included into the specified time interval.
- Each dictionary has the following elements:
- timeFrom, timeTill, skip, items
- these elements have the same meanings as the attributes of the events XIMSS data message
- An array of found Events, represented as dictionaries with the following elements:
- UID, timeFrom, dateFrom, duration, alarmTime
- these elements have the same meanings as the attributes of the event sub-elements of the events XIMSS data message
- the XML presentation of the found Event
- this element is present if the found Event is an exception of some other Event. The element value is the XML presentation of that parent Event.
- The value of the data element is included into the parent element value as a sub-element of its exceptions sub-element.
the calendarRef value should be a Calendar handle, and the params value should be a dictionary.
The function applies an operation specified with the params to the specified Calendar.
If the operation succeeds, this function returns a null-value. Otherwise it returns an error code string.
The operation performed is specified with the opCode string element of the params dictionary:
- The function publishes an Event or a ToDo element in the Calendar. Other params elements:
- an iCalendar element to place into the Calendar.
- (optional) array containing the item attachments, each array element specified as an EMail part content.
- If this element is not specified, and a calendaring item with the same UID already exists in the Calendar, then all attachments are copied from the existing item. To remove all attachments, specify an empty array.
- this optional string element has the same meaning as the attribute of the XIMSS calendarPublish operation.
- The function removes an Event or a ToDo element fr