A client can use the following operations to process a Calendar in the authenticated Account, as well as in other Accounts (by specifying the full Mailbox name as ~accountName@domainName/mailboxName).
This operation opens the specified Mailbox as a "Calendar".
A Calendar represents a Server Mailbox, with all messages being parsed and all calendaring information retrieved. Alternatively, a Calendar can represent an iCalendar document (a set of iCalendar events) retrieved via the HTTP/HTTPS protocol using the specified URL.
Each calendar has a name, and one session cannot have two calendars with the same name. On the other hand, the same session can open the same Mailbox as two different calendars (with different names).
- the name for the new Calendar to be opened. A client can use an arbitrary string as a Calendar name.
- if specified, the URL of a remote iCalendar object. The object is retrieved, parsed, and all its VEVENT elements are used as the Calendar object data. No Server Mailbox is read in this case.
- the Mailbox name. This attribute is used only if the url attribute is not specified. If this attribute is not specified, the calendar name is used.
A session can use several open Calendars at the same time.
- This operation closes an open Calendar.
- This operation retrieves the VEVENT objects from the specified Calendar. Only the Events that fall into the specified time interval are retrieved.
- timeFrom, timeTill
- the beginning and the end of the time interval (time values should be specified for the selected time zone).
- if this optional attribute exists, and its value is yes, the operation looks not for the Events in the specified time interval, but for the Events that have an Alert element set within the specified time interval.
- this optional numeric attribute limits the number of the Events returned.
- this optional numeric attribute specifies how many "to be returned" Events should be skipped. Using this attribute, a client can retrieve a large Event set in smaller "chunks".
- The Server sends one events data message for each 24-hour day (in the selected time zone) included into the specified time interval.
- This operation retrieves the VTODO objects from the specified Calendar. Only the Tasks that fall into the specified time interval are retrieved.
- calendar, timeFrom, timeTill, byAlarm, limit, skip
- these attributes have the same meanings as the findEvents operation attributes.
- The Server sends one tasks data message for each 24-hour day (in the selected time zone) included into the specified time interval.
- This operation tells the Server to retrieve a Message or its part. It is sent to the client as a calendarMessage data message.
- This operation is the same as the folderRead operation, but instead of the folder attribute it uses the calendar to specify the open Calendar name.
- Note: this operation cannot be applied to a Calendar object built using a remote (URL-specified) iCale