CalDAV Class

Properties Methods Events Configuration Settings Errors

The CalDAV Class implements an easy-to-use interface to the Calendaring Extensions to the Web Distributed Authoring and Versioning protocol (WebDAV). In this manner the CalDAV protocol specifies a standard way of accessing, managing, and sharing calendaring and scheduling information based on the iCalendar format.

Syntax

class ipworks.CalDAV

Remarks

The CalDAV Class supports both plaintext and SSL/TLS connections. When connecting over SSL/TLS the on_ssl_server_authentication event allows you to check the server identity and other security attributes. The on_ssl_status event provides information about the SSL handshake. Additional SSL related settings are also supported via the config method.

The class allows remote management of calendar events and collections of events (the calendar itself), including creation, deletion, listing, copying, and moving. Resource locking is also supported.

The get_calendar_report method will list the event resources contained in the calendar, and the report_filter can be used to limit the results returned. The on_event_details event will be fired for each matching calendar resource. You may also request a report containing a list of times that the owner is free or busy using the get_free_busy_report. The on_free_busy event will fire for each entry received, and the data fired in the event will also be stored in the free_busy property.

Single events can be added to a calendar (or updated) using the put_calendar_event method, and can be retrieved via the get_calendar_event method. Events may be copied or moved with the copy_calendar_event and move_calendar_event.

depth is used to determine which resources or properties are retrieved from the server. A depth of ResourceOnly will return only the resource associated with ResourceURI, or its properties. A depth of Infinity will return all resources contained within hierarchy, or their collective properties.

Note: Some servers (such as IIS 7.5) may not support a depth of Infinity by default and may return a HTTP 403 Forbidden response.

The following properties are used when creating a request with put_calendar_event or export_ics, and will be filled after calling get_calendar_event or import_ics. These will also be available from inside the on_event_details event, which is fired for each event received from the CalDAV server in response to a get_calendar_report.

Each method that acts on the calendar takes a ResourceURI parameter, which points to either an event resource or to the calendar itself. Event resources have a URI that ends with a filename and the ".ics" extension. Calendar resources end in a directory path. The following methods all act on events, and thus their ResourceURI parameters must terminate in a filename with the ".ics" extension:

These methods all act upon the calendar collection resource (the calendar itself):

The lock_calendar and un_lock_calendar methods may operate on individual events or on the whole calendar.

There is no standard format for resource URIs. Google for instance, uses "https://www.google.com/calendar/dav/" plus your email address to access the default calendar. So "https://www.google.com/calendar/dav/username@gmail.com/" is the base URI for the default calendar. If you have multiple calendars, replace the email address portion above with the Id of the calendar, plus "@group.calendar.google.com/". For instance: "https://www.google.com/calendar/dav/ev3nkr4ua83jej7q32oumn5eeo@group.calendar.google.com/". For Google, calendar events are stored in the "/events/" path. To retrieve a report on a calendar, you'd add "/events/" to one of the above paths. For example:

  CalDAV.GetCalendarReport("https://www.google.com/calendar/dav/username@gmail.com/events/");

Leaving the "/events/" out of the URI will result in an HTTP protocol error: 405 Method not allowed.

To add or retrieve an event, add the UID of the event you're creating or retrieving plus ".ics" to the path. Note that when putting an event with the put_calendar_event method, if the resourceURI and the UID do not match Google will create the event using the UID stored in the uid property. The actual location of will be newly added event will be returned in a "Location" header. This is the resource URI you must use to retrieve the event with get_calendar_event. For example:

  CalDAV.UID = "1234567890";
  CalDAV.PutCalendarEvent("https://www.google.com/calendar/dav/username@gmail.com/events/1234567890.ics");

Yahoo uses a different format for CalDAV access. Yahoo's ResourceURIs always start with "https://caldav.calendar.yahoo.com/dav/" plus your user name, plus "/Calendar/" plus the name of your calendar. For instance: "https://caldav.calendar.yahoo.com/dav/username/Calendar/Your_Name" for the default calendar. (Yahoo uses your name to create the default calendar). When using the create_calendar event to create a new calendar, replace "Your_Name" in the URI with the desired name of your new calendar. Event resources are located directly under the "/Calendar/Calendar_Name/" path. Like Google, the UID and filename portion of the resource URI must match, but Yahoo will actually return an HTTP protocol error if they differ. The examples below show a few possible transactions:

  CalDAVS1.User = "username";
  CalDAVS1.Password = "password";
  
  CalDAV.DisplayName = "My Hockey Calendar";
  CalDAV.CreateCalendar("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/");
  
  CalDAV.StartDate = "20100401T040000";
  CalDAV.EndDate = "20100401T060000";
  CalDAV.UID = "qwerty1234567";
  CalDAV.Summary = "First Practice";
  CalDAV.Location = "Rink on 1st and main";
  CalDAV.EventType = vEvent;
  CalDAV.PutCalendarEvent("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/qwerty1234567.ics");
  
  CalDAV.GetCalendarReport("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/");

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.


alarm_count	The number of records in the Alarm arrays.
alarm_action	This property determines what the CalDAV server will do when the alarm Trigger is reached.
alarm_attachment	This property contains a sound file attached to the alarm.
alarm_attachment_type	This property contains the MIME-Type of the attachment.
alarm_duration	This property contains the interval between repeating alarms.
alarm_message	This property contains a message used to alert the user when this alarm is triggered.
alarm_recipient	This property contains the email address of the person to be alerted when this alarm is triggered.
alarm_repeat	This property contains the number of times the alarm is to be repeated after the initial trigger.
alarm_subject	This property contains the subject of the message used to alert the user when this alarm is triggered.
alarm_trigger	This property contains the time when the alarm is triggered.
attendees	Defines one or more participants that have been invited to the event.
authorization	The Authorization string to be sent to the server.
auth_scheme	The authentication scheme to use when server authorization is required.
categories	Used to specify categories or subtypes of the calendar event.
classification	Defines the access classification for a calendar class.
completed	Date and time that a to-do was actually completed.
connected	Shows whether the class is connected.
cookie_count	The number of records in the Cookie arrays.
cookie_domain	The domain of a received cookie.
cookie_expiration	This property contains an expiration time for the cookie (if provided by the server).
cookie_name	The name of the cookie.
cookie_path	This property contains a path name to limit the cookie to (if provided by the server).
cookie_secure	This property contains the security flag of the received cookie.
cookie_value	This property contains the value of the cookie.
created	Date and time calendar information created.
custom_property_count	The number of records in the CustomProperty arrays.
custom_property_attribute	This property contains an optional attribute of the custom property.
custom_property_name	This property contains the textual name of the custom property.
custom_property_value	This property contains the value of the custom property.
depth	The depth associated with the current operation.
description	Provides a complete description of the calendar event.
display_name	Provides the display name of the calendar being created.
due_date	Specifies the due date for a calendar event.
duration	Duration of the calendar event.
end_date	Specifies the date and time that a calendar event ends.
e_tag	Identifier returned by the CalDAV server which is used to synchronize edits.
event_type	Indicates the type of calendar object resource.
firewall_auto_detect	This property tells the class whether or not to automatically detect and use firewall system settings, if available.
firewall_type	This property determines the type of firewall to connect through.
firewall_host	This property contains the name or IP address of firewall (optional).
firewall_password	This property contains a password if authentication is to be used when connecting through the firewall.
firewall_port	This property contains the TCP port for the firewall Host .
firewall_user	This property contains a user name if authentication is to be used connecting through a firewall.
follow_redirects	Determines what happens when the server issues a redirect.
free_busy_count	The number of records in the FreeBusy arrays.
free_busy_range	Contains the date/time range when the calendar owner is busy.
free_busy_type	Indicates the busy status of the corresponding BusyRange .
idle	The current status of the class.
last_modified	The date and time that the information associated with the calendar event was last revised in the calendar store.
local_host	The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
location	Defines the intended venue for the activity defined by a calendar class.
lock_type	The type of the current resource lock.
lock_owner	The principle that owns the current resource lock.
lock_scope	The scope of the current resource lock.
lock_timeout	The time to live for the current resource lock.
lock_tokens	The lock string to be used when submitting operations on a locked resource.
organizer	Defines the organizer of a calendar event.
other_headers	Other headers as determined by the user (optional).
parsed_header_count	The number of records in the ParsedHeader arrays.
parsed_header_field	This property contains the name of the HTTP header (same case as it is delivered).
parsed_header_value	This property contains the header contents.
password	A password if authentication is to be used.
priority	Defines the relative priority for a calendar event.
proxy_auth_scheme	This property is used to tell the class which type of authorization to perform when connecting to the proxy.
proxy_auto_detect	This property tells the class whether or not to automatically detect and use proxy system settings, if available.
proxy_password	This property contains a password if authentication is to be used for the proxy.
proxy_port	This property contains the TCP port for the proxy Server (default 80).
proxy_server	If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
proxy_ssl	This property determines when to use SSL for the connection to the proxy.
proxy_user	This property contains a user name, if authentication is to be used for the proxy.
recurrence_dates	Individual dates on which the event will recur.
recurrence_exception_dates	Defines the list of DATE-TIME exceptions to the recurrence set.
recurrence_exception_rule	Defines a rule or repeating pattern for an exception to the recurrence set.
recurrence_id	Identifies a recurring event.
recurrence_rule	This property defines the recurrence rule for the event.
report_filter_alarm_end	Limits the events returned in the report to only those with an alarm set in the range specified by AlarmStart and AlarmEnd .
report_filter_alarm_start	Limits the events returned in the report to only those with an alarm set in the range specified by AlarmStart and AlarmEnd .
report_filter_custom_filter	Allows the user to specify his own filter XML.
report_filter_end_date	Limits the events returned in the report to only those which occur in the time range specified by StartDate and EndDate .
report_filter_event_type	Indicates the type of calendar object resources to return in a Report.
report_filter_property	Limits the events returned in a Report to only those which contain a matching property name and value.
report_filter_recur_end	Limits the recurring events returned in the report.
report_filter_recur_start	Limits the recurring events returned in the report.
report_filter_return_calendar_data	Controls whether the contents of each calendar event is returned in the report.
report_filter_start_date	Limits the events returned in the report to only those which occur in the time range specified by StartDate and EndDate .
report_filter_uid	Limits the recurring events returned in the report to only those with the specified UID.
sequence	Defines the revision sequence number of the event within a sequence of revisions.
ssl_accept_server_cert_encoded	The certificate (PEM/base64 encoded).
ssl_cert_encoded	The certificate (PEM/base64 encoded).
ssl_cert_store	The name of the certificate store for the client certificate.
ssl_cert_store_password	If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.
ssl_cert_store_type	The type of certificate store for this certificate.
ssl_cert_subject	The subject of the certificate used for client authentication.
ssl_server_cert_encoded	The certificate (PEM/base64 encoded).
start_date	Specifies the date and time that an event begins.
status	Defines the overall status or confirmation for the calendar event.
status_line	The first line of the last server response.
summary	Defines a short summary or subject for the calendar event.
timeout	A timeout for the class.
timestamp	Specifies the date and time that the instance of the event was created.
timezone_dst_name	The customary name for the daylight-savings time zone.
timezone_dst_offset_from	The UTC offset that is in use when the onset of this time zone observance begins.
timezone_dst_offset_to	The UTC offset for daylight savings time, when this observance is in use.
timezone_dst_rule	This property defines the recurrence rule for the onset of this daylight savings time observance.
timezone_dst_start	The effective onset date and local time for the daylight-time time zone definition.
timezone_last_modified	This optional property is a UTC value that specifies the date and time that this time zone definition was last updated.
timezone_std_name	The customary name for the standard time zone.
timezone_std_offset_from	The UTC offset that is in use when the onset of this time zone observance begins.
timezone_std_offset_to	The UTC offset for standard time, when this observance is in use.
timezone_std_rule	This property defines the recurrence rule for the onset of this standard time observance.
timezone_std_start	The effective onset date and local time for the standard-time time zone definition.
timezone_id	This property specifies a text value that uniquely identifies this CalTimezone calendar class.
timezone_url	Optionally points to a published time zone definition.
transparency	Defines whether or not an event is transparent to busy time searches.
uid	A persistent, globally unique identifier for the calendar event.
url	Location of the event resource on the CalDAV server.
user	A user name if authentication is to be used.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.


add_cookie	Adds a cookie and the corresponding value to the outgoing request headers.
add_custom_property	Adds a form variable and the corresponding value.
config	Sets or retrieves a configuration setting.
copy_calendar_event	Copy events to a new location.
create_calendar	Creates a new calendar collection resource.
delete_calendar_event	Delete a resource or collection.
do_events	Processes events from the internal message queue.
export_ics	Generates an event from the properties in the iCal (.ICS) format.
get_calendar_event	Retrieves a single event from the CalDAV server.
get_calendar_options	Retrieves options for the ResourceURI to determines whether it supports calendar access.
get_calendar_report	Generates a report on the indicated calendar collection resource.
get_free_busy_report	Generates a report as to when the calendar owner is free and/or busy.
import_ics	Imports iCal data (contained in an ICS file) into the class's property list.
interrupt	Interrupt the current method.
lock_calendar	Obtain a lock for a specified calendar resource.
move_calendar_event	Moves one calendar resource to a new location.
put_calendar_event	Adds a calendar resource at the specified ResourceURI using the CalDAV PUT method.
reset	Reset the class.
un_lock_calendar	Unlocks a calendar resource.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.


on_connected	Fired immediately after a connection completes (or fails).
on_connection_status	Fired to indicate changes in connection state.
on_disconnected	Fired when a connection is closed.
on_end_transfer	Fired when a document finishes transferring.
on_error	Information about errors during data delivery.
on_event_details	Fires for each calendar event received.
on_free_busy	Fires for each Free/Busy element received in the response.
on_header	Fired every time a header line comes in.
on_log	Fires once for each log message.
on_redirect	Fired when a redirection is received from the server.
on_set_cookie	Fired for every cookie set by the server.
on_ssl_server_authentication	Fired after the server presents its certificate to the client.
on_ssl_status	Shows the progress of the secure connection.
on_start_transfer	Fired when a document starts transferring (after the headers).
on_status	Fired when the HTTP status line is received from the server.
on_transfer	Fired while a document transfers (delivers document).

Configuration Settings

The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.


AuthScheme	The authentication scheme to use for server authorization.
BuildEvent	Builds the current event for a multi-event calendar entry.
EndCalendar	Signifies the end of a multi-event calendar entry.
ExpandRecurringEvents	Instructs the class to return all instances of a recurring event within a timeframe.
ProductId	Specifies the identifier for the product that created the iCalendar object.
RecurrenceExceptionDatesAttrs	Specifies the attributes for the exception dates of a recurring event.
StartCalendar	Signifies the beginning of a multi-event calendar entry.
IsDir[i]	Whether or not the resource at the specified index is a directory.
AcceptEncoding	Used to tell the server which types of content encodings the client supports.
AllowHTTPCompression	This property enables HTTP compression for receiving data.
AllowHTTPFallback	Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.
Append	Whether to append data to LocalFile.
Authorization	The Authorization string to be sent to the server.
BytesTransferred	Contains the number of bytes transferred in the response data.
ChunkSize	Specifies the chunk size in bytes when using chunked encoding.
CompressHTTPRequest	Set to true to compress the body of a PUT or POST request.
EncodeURL	If set to true the URL will be encoded by the class.
FollowRedirects	Determines what happens when the server issues a redirect.
GetOn302Redirect	If set to true the class will perform a GET on the new location.
HTTP2HeadersWithoutIndexing	HTTP2 headers that should not update the dynamic header table with incremental indexing.
HTTPVersion	The version of HTTP used by the class.
IfModifiedSince	A date determining the maximum age of the desired document.
KeepAlive	Determines whether the HTTP connection is closed after completion of the request.
KerberosSPN	The Service Principal Name for the Kerberos Domain Controller.
LogLevel	The level of detail that is logged.
MaxRedirectAttempts	Limits the number of redirects that are followed in a request.
NegotiatedHTTPVersion	The negotiated HTTP version.
OtherHeaders	Other headers as determined by the user (optional).
ProxyAuthorization	The authorization string to be sent to the proxy server.
ProxyAuthScheme	The authorization scheme to be used for the proxy.
ProxyPassword	A password if authentication is to be used for the proxy.
ProxyPort	Port for the proxy server (default 80).
ProxyServer	Name or IP address of a proxy server (optional).
ProxyUser	A user name if authentication is to be used for the proxy.
SentHeaders	The full set of headers as sent by the client.
StatusLine	The first line of the last response from the server.
TransferredData	The contents of the last response from the server.
TransferredDataLimit	The maximum number of incoming bytes to be stored by the class.
TransferredHeaders	The full set of headers as received from the server.
TransferredRequest	The full request as sent by the client.
UseChunkedEncoding	Enables or Disables HTTP chunked encoding for transfers.
UseIDNs	Whether to encode hostnames to internationalized domain names.
UsePlatformHTTPClient	Whether or not to use the platform HTTP client.
UserAgent	Information about the user agent (browser).
ConnectionTimeout	Sets a separate timeout value for establishing a connection.
FirewallAutoDetect	Tells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallHost	Name or IP address of firewall (optional).
FirewallPassword	Password to be used if authentication is to be used when connecting through the firewall.
FirewallPort	The TCP port for the FirewallHost;.
FirewallType	Determines the type of firewall to connect through.
FirewallUser	A user name if authentication is to be used connecting through a firewall.
KeepAliveInterval	The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTime	The inactivity time in milliseconds before a TCP keep-alive packet is sent.
Linger	When set to True, connections are terminated gracefully.
LingerTime	Time in seconds to have the connection linger.
LocalHost	The name of the local host through which connections are initiated or accepted.
LocalPort	The port in the local host where the class binds.
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
MaxTransferRate	The transfer rate limit in bytes per second.
ProxyExceptionsList	A semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAlive	Determines whether or not the keep alive socket option is enabled.
TcpNoDelay	Whether or not to delay when sending packets.
UseIPv6	Whether to use IPv6.
LogSSLPackets	Controls whether SSL packets are logged when using the internal security API.
OpenSSLCADir	The path to a directory containing CA certificates.
OpenSSLCAFile	Name of the file containing the list of CA's trusted by your application.
OpenSSLCipherList	A string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedData	The data to seed the pseudo random number generator (PRNG).
ReuseSSLSession	Determines if the SSL session is reused.
SSLCACertFilePaths	The paths to CA certificate files on Unix/Linux.
SSLCACerts	A newline separated list of CA certificate to use during SSL client authentication.
SSLCheckCRL	Whether to check the Certificate Revocation List for the server certificate.
SSLCipherStrength	The minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuites	The cipher suite to be used in an SSL negotiation.
SSLEnabledProtocols	Used to enable/disable the supported security protocols.
SSLEnableRenegotiation	Whether the renegotiation_info SSL extension is supported.
SSLIncludeCertChain	Whether the entire certificate chain is included in the SSLServerAuthentication event.
SSLNegotiatedCipher	Returns the negotiated ciphersuite.
SSLNegotiatedCipherStrength	Returns the negotiated ciphersuite strength.
SSLNegotiatedCipherSuite	Returns the negotiated ciphersuite.
SSLNegotiatedKeyExchange	Returns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrength	Returns the negotiated key exchange algorithm strength.
SSLNegotiatedVersion	Returns the negotiated protocol version.
SSLProvider	The name of the security provider to use.
SSLSecurityFlags	Flags that control certificate verification.
SSLServerCACerts	A newline separated list of CA certificate to use during SSL server certificate validation.
TLS12SignatureAlgorithms	Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLS12SupportedGroups	The supported groups for ECC.
TLS13KeyShareGroups	The groups for which to pregenerate key shares.
TLS13SignatureAlgorithms	The allowed certificate signature algorithms.
TLS13SupportedGroups	The supported groups for (EC)DHE key exchange.
AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallData	Used to send extra data to the firewall.
InBufferSize	The size in bytes of the incoming queue of the socket.
OutBufferSize	The size in bytes of the outgoing queue of the socket.
BuildInfo	Information about the product's build.
CodePage	The system code page used for Unicode to Multibyte translations.
LicenseInfo	Information about the current license.
ProcessIdleEvents	Whether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillis	The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPI	Tells the class whether or not to use the system security libraries or an internal implementation.