CalDAV Class

Properties   Methods   Events   Config 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 calendar events based on the iCalendar format.

Syntax

class ipworks.CalDAV

Remarks

The CalDAV &class allows remote management of calendars and their events. Supported operations include creation, deletion, listing, copying, and moving of events. 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 create_event method, and can be retrieved via the get_event method. Events may be copied or moved with the copy_event and move_event.

The following properties are used when creating a request with create_event or export_ics, and will be filled after calling get_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.

• alarms
• attendees
• categories
• classification
• completed
• Created
• custom_properties
• Depth
• description
• duration
• end_date
• event_type
• last_modified
• location
• organizer
• priority
• recurrence
• sequence
• start_date
• status
• summary
• timestamp
• timezone
• transparency
• uid
• url

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:

• copy_event
• delete_event
• move_event
• get_event
• create_event

• create_calendar
• get_calendar_options
• get_calendar_report
• get_free_busy_report

There is no standard format for resource URIs. Google for instance, uses "https://apidata.googleusercontent.com/caldav/v2/" plus your email address to access the default calendar. So "https://apidata.googleusercontent.com/caldav/v2/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://apidata.googleusercontent.com/caldav/v2/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://apidata.googleusercontent.com/caldav/v2/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 create_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_event. For example: CalDAV.UID = "1234567890"; CalDAV.CreateEvent("https://apidata.googleusercontent.com/caldav/v2/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: CalDAV.User = "username"; CalDAV.Password = "password"; CalDAV.CreateCalendar("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/", "My Hockey Calendar", "My 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.CreateEvent("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.

Method List

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

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.

Config Settings

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

alarm_count Property

The number of records in the Alarm arrays.

Syntax

def get_alarm_count() -> int: ...
def set_alarm_count(value: int) -> None: ...

alarm_count = property(get_alarm_count, set_alarm_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• alarm_action
• alarm_attachment
• alarm_attachment_type
• alarm_duration
• alarm_message
• alarm_recipient
• alarm_repeat
• alarm_subject
• alarm_trigger

The array indices start at 0 and end at alarm_count - 1.

alarm_action Property

This property determines what the CalDAV server will do when the alarm Trigger is reached.

Syntax

def get_alarm_action(alarm_index: int) -> int: ...
def set_alarm_action(alarm_index: int, value: int) -> None: ...

Default Value

0

Remarks

This property determines what the CalDAV server will do when the alarm alarm_trigger is reached. The following table explains the possible alarm actions:

The alarm_index parameter specifies the index of the item in the array. The size of the array is controlled by the alarm_count property.

alarm_attachment Property

This property contains a sound file attached to the alarm.

Syntax

def get_alarm_attachment(alarm_index: int) -> str: ...
def set_alarm_attachment(alarm_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property contains a sound file attached to the alarm. If the alarm_action is set to aAudio, this property may optionally contain a base-64 encoded binary sound file to be played. The alarm_attachment_type property indicates the data type of the attached file.

The alarm_index parameter specifies the index of the item in the array. The size of the array is controlled by the alarm_count property.

alarm_attachment_type Property

This property contains the MIME-Type of the attachment.

Syntax

def get_alarm_attachment_type(alarm_index: int) -> str: ...
def set_alarm_attachment_type(alarm_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property contains the MIME-Type of the attachment. If the alarm_action is set to aAudio or aEmail the alarm_attachment property may optionally contain a base-64 binary encoded attachment. The alarm_attachment_type property is used to tell the CalDAV server what type of binary file it is receiving. This property is a standard MIME content type, in the format "type/sub-type". The most common audio types are shown in the table below:

You may use standard MIME content-types for any other file type you wish to submit in the alarm_attachment property. If alarm_attachment is specified but alarm_attachment_type is left blank, no format type will be submitted with the alarm_attachment and the CalDAV server may (or may not) attempt to determine the data type itself.

The alarm_index parameter specifies the index of the item in the array. The size of the array is controlled by the alarm_count property.

alarm_duration Property

This property contains the interval between repeating alarms.

Syntax

def get_alarm_duration(alarm_index: int) -> str: ...
def set_alarm_duration(alarm_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property contains the interval between repeating alarms. This property is only used when an alarm is set to alarm_repeat multiple times. It is specified in the form of a Duration data type. Durations are represented by the format P<date>T<time>. The date component may contain a number of days or weeks (but not months or years), and the time component may consist of hours, minutes, and seconds. These are represented by an integer value followed by a letter representing the units, as specified by the table below:

This format is based on ISO-8601, but unlike the ISO specification this duration property does not support durations measured in years or months.

The following is an example of an alarm that repeats 4 additional times after the initial alarm_trigger, with a 5-minute delay between each alarm: CalDav.Trigger = "-PT10M"; CalDAV.Alarm.Repeat = 4; CalDAV.Duration = "PT5M" CalDAV.Action = aDisplay;

If alarm_duration is specified, alarm_repeat MUST also be specified.

The alarm_index parameter specifies the index of the item in the array. The size of the array is controlled by the alarm_count property.

alarm_message Property

This property contains a message used to alert the user when this alarm is triggered.

Syntax

def get_alarm_message(alarm_index: int) -> str: ...
def set_alarm_message(alarm_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property contains a message used to alert the user when this alarm is triggered. If the alarm_action is set to aDisplay, this property must contain the message that is to be displayed to the user. If alarm_action is set to aEmail this property will contain the message body of the email that is sent to the alarm_recipient. 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."; or CalDAV.Alarm.Action = aDisplay; CalDAV.Alarm.Message = "REMINDER: Send agenda for weekly staff meeting."; alarm_message is not used for the aAudio alarm alarm_action.

The alarm_index parameter specifies the index of the item in the array. The size of the array is controlled by the alarm_count property.

alarm_recipient Property

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

Syntax

def get_alarm_recipient(alarm_index: int) -> str: ...
def set_alarm_recipient(alarm_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property contains the email address of the person to be alerted when this alarm is triggered. If alarm_action 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."; alarm_recipient is not used for the aAudio or aDisplay alarm alarm_actions.

The alarm_index parameter specifies the index of the item in the array. The size of the array is controlled by the alarm_count property.

alarm_repeat Property

This property contains the number of times the alarm is to be repeated after the initial trigger.

Syntax

def get_alarm_repeat(alarm_index: int) -> int: ...
def set_alarm_repeat(alarm_index: int, value: int) -> None: ...

Default Value

0

Remarks

This property contains the number of times the alarm is to be repeated after the initial trigger.

This property defines the number of times an alarm should be repeated after its initial alarm_trigger. If the alarm triggers more than once, then this property MUST be specified along with the alarm_duration property.

The alarm_index parameter specifies the index of the item in the array. The size of the array is controlled by the alarm_count property.

alarm_subject Property

This property contains the subject of the message used to alert the user when this alarm is triggered.

Syntax

def get_alarm_subject(alarm_index: int) -> str: ...
def set_alarm_subject(alarm_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property contains the subject of the message used to alert the user when this alarm is triggered. If alarm_action is set to aEmail this property will contain the subject the email that is sent to the alarm_recipient. 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."; alarm_subject is not used for the aAudio or aDisplay alarm alarm_actions.

The alarm_index parameter specifies the index of the item in the array. The size of the array is controlled by the alarm_count property.

alarm_trigger Property

This property contains the time when the alarm is triggered.

Syntax

def get_alarm_trigger(alarm_index: int) -> str: ...
def set_alarm_trigger(alarm_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property contains the time when the alarm is triggered.

The alarm_trigger is represented as a duration relative to the start of an event. The format is (+/-)P<date>T<time>. The date component may contain a number of days or weeks (but not months or years), and the time component may consist of hours, minutes, and seconds. These are represented by an integer value followed by a letter representing the units, as specified by the table below:

The alarm_index parameter specifies the index of the item in the array. The size of the array is controlled by the alarm_count property.

attendees Property

Defines one or more participants that have been invited to the event.

Syntax

def get_attendees() -> str: ...
def set_attendees(value: str) -> None: ...

attendees = property(get_attendees, set_attendees)

Default Value

""

Remarks

This property may contain a comma-separated list of attendees that have been invited to an event. Each email address should be in the mailto URI format (as defined in RFC2368). For instance: CalDAV.Attendees = "mailto:johnsmith@example.com,mailto:janedoe@test.com"

This property is filled from the response to a get_event, and is also used when creating an event to be added using the create_event method. However, when requesting a report using the get_calendar_report method, the contents of this property will only be valid inside the on_event_details event.

authorization Property

This property includes the Authorization string to be sent to the server.

Syntax

def get_authorization() -> str: ...
def set_authorization(value: str) -> None: ...

authorization = property(get_authorization, set_authorization)

Default Value

""

Remarks

If the authorization property contains a nonempty string, an Authorization HTTP request header is added to the request. This header conveys Authorization information to the server.

A common use for this property is to specify OAuth authorization string.

This property is provided so that the HTTP class can be extended with other security schemes in addition to the authorization schemes already implemented by the class.

The auth_scheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time user and password are set, they are Base64 encoded, and the result is put in the authorization property in the form "Basic [encoded-user-password]".

auth_scheme Property

This property specifies the authentication scheme to use when server authentication is required.

Syntax

def get_auth_scheme() -> int: ...
def set_auth_scheme(value: int) -> None: ...

auth_scheme = property(get_auth_scheme, set_auth_scheme)

Default Value

0

Remarks

This property will tell the class which type of authorization to perform when the user and password properties are set.

This property should be set to authNone (3) when no authentication is to be performed.

By default, this property is authBasic (0), and if the user and password properties are set, the class will attempt HTTP Basic Authentication. If auth_scheme is set to authDigest (1), authNtlm (4), or authNegotiate (5), then Digest, NTLM, or Windows Negotiate (Kerberos) authentication will be attempted instead.

If auth_scheme is set to authProprietary (2), then the authorization token must be supplied through the authorization property.

If auth_scheme is set to authOAuth (6), then the authorization string must be supplied through the authorization property.

Note: If you set the authorization property and auth_scheme is not authProprietary or authOAuth, then the auth_scheme will be set automatically to authProprietary (2) by the class.

For security, changing the value of this property will cause the class to clear the values of user, password, and Authorization.

calendar_count Property

The number of records in the Calendar arrays.

Syntax

def get_calendar_count() -> int: ...
def set_calendar_count(value: int) -> None: ...

calendar_count = property(get_calendar_count, set_calendar_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• calendar_color
• calendar_c_tag
• calendar_description
• calendar_display_name
• calendar_property_count
• calendar_property_index
• calendar_property_name
• calendar_property_value
• calendar_url

The array indices start at 0 and end at calendar_count - 1.

calendar_color Property

This property specifies the calendar's color.

Syntax

def get_calendar_color(calendar_index: int) -> str: ...
def set_calendar_color(calendar_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property specifies the calendar's color. For instance #C2C2C2FF. This property corresponds to the calendar-color property.

The calendar_index parameter specifies the index of the item in the array. The size of the array is controlled by the calendar_count property.

calendar_c_tag Property

This property holds the current ctag of the calendar.

Syntax

def get_calendar_c_tag(calendar_index: int) -> str: ...
def set_calendar_c_tag(calendar_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property holds the current ctag of the calendar. The ctag value is updated by the server when any changes have been made to the calendar. This may be used to determine if any changes have been made to the calendar since the last reported ctag.

The calendar_index parameter specifies the index of the item in the array. The size of the array is controlled by the calendar_count property.

calendar_description Property

This property holds the description of the calendar.

Syntax

def get_calendar_description(calendar_index: int) -> str: ...
def set_calendar_description(calendar_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property holds the description of the calendar. This value corresponds to the calendar-description property.

The calendar_index parameter specifies the index of the item in the array. The size of the array is controlled by the calendar_count property.

calendar_display_name Property

This property holds the display name of the calendar.

Syntax

def get_calendar_display_name(calendar_index: int) -> str: ...
def set_calendar_display_name(calendar_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property holds the display name of the calendar.

The calendar_index parameter specifies the index of the item in the array. The size of the array is controlled by the calendar_count property.

calendar_property_count Property

This property holds the total number of properties of the calendar.

Syntax

def get_calendar_property_count(calendar_index: int) -> int: ...

Default Value

0

Remarks

This property holds the total number of properties of the calendar. This property, in conjunction with calendar_property_index, calendar_property_name and calendar_property_value provide a way to obtain additional property values that do not correspond to existing properties. For instance: for (int i = 0; i < component.Calendars[0].PropertyCount; i++) { //Setting PropertyIndex selects the property component.Calendars[0].PropertyIndex = i; //After selecting the property by setting PropertyIndex output the property name and value Console.WriteLine(component.Calendars[0].PropertyName + ": " + component.Calendars[0].PropertyValue); }

Note that complex properties that include nested elements are not supported at this time and are not present in the property collection.

The calendar_index parameter specifies the index of the item in the array. The size of the array is controlled by the calendar_count property.

This property is read-only.

calendar_property_index Property

This property specifies the currently selected property.

Syntax

def get_calendar_property_index(calendar_index: int) -> int: ...
def set_calendar_property_index(calendar_index: int, value: int) -> None: ...

Default Value

0

Remarks

This property specifies the currently selected property. Please see calendar_property_count for details.

The calendar_index parameter specifies the index of the item in the array. The size of the array is controlled by the calendar_count property.

calendar_property_name Property

This property holds the name of the currently selected property.

Syntax

def get_calendar_property_name(calendar_index: int) -> str: ...

Default Value

"0"

Remarks

This property holds the name of the currently selected property. Please see calendar_property_count for details.

The calendar_index parameter specifies the index of the item in the array. The size of the array is controlled by the calendar_count property.

This property is read-only.

calendar_property_value Property

This property holds the value of the currently selected property.

Syntax

def get_calendar_property_value(calendar_index: int) -> str: ...

Default Value

""

Remarks

This property holds the value of the currently selected property. Please see calendar_property_count for details.

The calendar_index parameter specifies the index of the item in the array. The size of the array is controlled by the calendar_count property.

This property is read-only.

calendar_url Property

This property provides the URL of the calendar.

Syntax

def get_calendar_url(calendar_index: int) -> str: ...
def set_calendar_url(calendar_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property provides the URL of the calendar. This URL is used when managing events within a calendar, or managing the calendar itself.

The calendar_index parameter specifies the index of the item in the array. The size of the array is controlled by the calendar_count property.

categories Property

Used to specify categories or subtypes of the calendar event.

Syntax

def get_categories() -> str: ...
def set_categories(value: str) -> None: ...

categories = property(get_categories, set_categories)

Default Value

""

Remarks

This property is used to specify the categories or subtypes contained in a calendar event. The categories are useful in searching for an event of a particular type and/or category. Within the "VEVENT", "VTODO", or "VJOURNAL" calendar components, more than one category can be specified as a COMMA-separated list of categories. For example: CalDAV.CalendarEvents[0].Category = "APPOINTMENT,EDUCATION,MEETING";

This property is filled from the response to a get_event, and is also used when creating an event to be added using the create_event method. However, when requesting a report using the get_calendar_report method, the contents of this property will only be valid inside the on_event_details event.

classification Property

Defines the access classification for a calendar class.

Syntax

def get_classification() -> str: ...
def set_classification(value: str) -> None: ...

classification = property(get_classification, set_classification)

Default Value

""

Remarks

This property provides a method for capturing the access that the owner wishes to allow for the calendar component. Standard values include "PUBLIC", "PRIVATE", and "CONFIDENTIAL", but calendars may support additional values as well as user-defined values. If not specified, the default value is PUBLIC. Applications MUST treat classification values that they do not recognize the same way as they would the PRIVATE value.

This property is filled from the response to a get_event, and is also used when creating an event to be added using the create_event method. However, when requesting a report using the get_calendar_report method, the contents of this property will only be valid inside the on_event_details event.

completed Property

Date and time that a to-do was actually completed.

Syntax

def get_completed() -> str: ...
def set_completed(value: str) -> None: ...

completed = property(get_completed, set_completed)

Default Value

""

Remarks

This property defines the date and time that a to-do was actually completed. This property is only applicable for the vTodo event_type. The date/time format is "YYYYMMDDThhmmss", where "T" indicates the break between date and time. You may also append a 1-character alpha code for the timezone. For instance, "20100104T123456Z" indicates January 4th, 2010 at 12:34:56 PM UTC.

This property is filled from the response to a get_event, and is also used when creating an event to be added using the create_event method. However, when requesting a report using the get_calendar_report method, the contents of this property will only be valid inside the on_event_details event.

connected Property

Whether the class is connected.

Syntax

def get_connected() -> bool: ...

connected = property(get_connected, None)

Default Value

FALSE

Remarks

This property is used to determine whether or not the class is connected to the remote host. Use the connect and disconnect methods to manage the connection.

This property is read-only.

cookie_count Property

The number of records in the Cookie arrays.

Syntax

def get_cookie_count() -> int: ...
def set_cookie_count(value: int) -> None: ...

cookie_count = property(get_cookie_count, set_cookie_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• cookie_domain
• cookie_expiration
• cookie_name
• cookie_path
• cookie_secure
• cookie_value

The array indices start at 0 and end at cookie_count - 1.

cookie_domain Property

The domain of a received cookie.

Syntax

def get_cookie_domain(cookie_index: int) -> str: ...

Default Value

""

Remarks

The domain of a received cookie. This property contains a domain name to limit the cookie to (if provided by the server). If the server does not provide a domain name, this property will contain an empty string. The convention in this case is to use the server name specified by url_server as the cookie domain.

The cookie_index parameter specifies the index of the item in the array. The size of the array is controlled by the cookie_count property.

This property is read-only.

cookie_expiration Property

An expiration time for the cookie (if provided by the server).

Syntax

def get_cookie_expiration(cookie_index: int) -> str: ...

Default Value

""

Remarks

An expiration time for the cookie (if provided by the server). The time format used is "Weekday, DD-Mon-YY HH:MM:SS GMT". If the server does not provide an expiration time, this property will contain an empty string. The convention is to drop the cookie at the end of the session.

The cookie_index parameter specifies the index of the item in the array. The size of the array is controlled by the cookie_count property.

This property is read-only.

cookie_name Property

The name of the cookie.

Syntax

def get_cookie_name(cookie_index: int) -> str: ...
def set_cookie_name(cookie_index: int, value: str) -> None: ...

Default Value

""

Remarks

The name of the cookie.

This property, along with cookie_value, stores the cookie that is to be sent to the server. The on_set_cookie event displays the cookies sent by the server and their properties.

The cookie_index parameter specifies the index of the item in the array. The size of the array is controlled by the cookie_count property.

cookie_path Property

A path name to limit the cookie to (if provided by the server).

Syntax

def get_cookie_path(cookie_index: int) -> str: ...

Default Value

""

Remarks

A path name to limit the cookie to (if provided by the server). If the server does not provide a cookie path, the path property will be an empty string. The convention in this case is to use the path specified by url_path as the cookie path.

The cookie_index parameter specifies the index of the item in the array. The size of the array is controlled by the cookie_count property.

This property is read-only.

cookie_secure Property

The security flag of the received cookie.

Syntax

def get_cookie_secure(cookie_index: int) -> bool: ...

Default Value

FALSE

Remarks

The security flag of the received cookie. This property specifies whether the cookie is secure. If the value of this property is True, the cookie value must be submitted only through a secure (HTTPS) connection.

The cookie_index parameter specifies the index of the item in the array. The size of the array is controlled by the cookie_count property.

This property is read-only.

cookie_value Property

The value of the cookie.

Syntax

def get_cookie_value(cookie_index: int) -> str: ...
def set_cookie_value(cookie_index: int, value: str) -> None: ...

Default Value

""

Remarks

The value of the cookie. A corresponding value is associated with the cookie specified by cookie_name. This property holds that value.

The on_set_cookie event provides the cookies set by the server.

The cookie_index parameter specifies the index of the item in the array. The size of the array is controlled by the cookie_count property.

custom_property_count Property

The number of records in the CustomProperty arrays.

Syntax

def get_custom_property_count() -> int: ...
def set_custom_property_count(value: int) -> None: ...

custom_property_count = property(get_custom_property_count, set_custom_property_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• custom_property_attribute
• custom_property_name
• custom_property_value

The array indices start at 0 and end at custom_property_count - 1.

custom_property_attribute Property

This property contains an optional attribute of the custom property.

Syntax

def get_custom_property_attribute(custom_property_index: int) -> str: ...
def set_custom_property_attribute(custom_property_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property contains an optional attribute of the custom property.

The custom_property_index parameter specifies the index of the item in the array. The size of the array is controlled by the custom_property_count property.

custom_property_name Property

This property contains the textual name of the custom property.

Syntax

def get_custom_property_name(custom_property_index: int) -> str: ...
def set_custom_property_name(custom_property_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property contains the textual name of the custom property.

The custom_property_index parameter specifies the index of the item in the array. The size of the array is controlled by the custom_property_count property.

custom_property_value Property

This property contains the value of the custom property.

Syntax

def get_custom_property_value(custom_property_index: int) -> str: ...
def set_custom_property_value(custom_property_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property contains the value of the custom property.

The custom_property_index parameter specifies the index of the item in the array. The size of the array is controlled by the custom_property_count property.

description Property

Provides a complete description of the calendar event.

Syntax

def get_description() -> str: ...
def set_description(value: str) -> None: ...

description = property(get_description, set_description)

Default Value

""

Remarks

This property provides a more complete description of the event than is provided by the summary property.

due_date Property

Specifies the due date for a calendar event.

Syntax

def get_due_date() -> str: ...
def set_due_date(value: str) -> None: ...

due_date = property(get_due_date, set_due_date)

Default Value

""

Remarks

This setting can be used to configure or obtain the due date for the selected calendar event.

Note: The format of this property should be the same as end_date.

duration Property

Duration of the calendar event.

Syntax

def get_duration() -> str: ...
def set_duration(value: str) -> None: ...

duration = property(get_duration, set_duration)

Default Value

""

Remarks

This property contains the duration for a calendar event. Durations are represented by the format P<date>T<time>. The date component may contain a number of days or weeks (but not months or years), and the time component may consist of hours, minutes, and seconds. These are represented by an integer value followed by a letter representing the units, as specified by the table below:

This format is based on ISO-8601, but unlike the ISO specification this duration property does not support durations measured in years or months.

This property is filled from the response to a get_event, and is also used when creating an event to be added using the create_event method. However, when requesting a report using the get_calendar_report method, the contents of this property will only be valid inside the on_event_details event.

end_date Property

Specifies the date and time that a calendar event ends.

Syntax

def get_end_date() -> str: ...
def set_end_date(value: str) -> None: ...

end_date = property(get_end_date, set_end_date)

Default Value

""

Remarks

This property specifies the date and time that a calendar event will end. The date/time format is "YYYYMMDDThhmmss", where "T" indicates the break between date and time. You may also append a 1-character alpha code for the timezone. For instance, "20100104T123456Z" indicates January 4th, 2010 at 12:34:56 PM UTC.

This property is filled from the response to a get_event, and is also used when creating an event to be added using the create_event method. However, when requesting a report using the get_calendar_report method, the contents of this property will only be valid inside the on_event_details event.

e_tag Property

Identifier returned by the CalDAV server which is used to synchronize edits.

Syntax

def get_e_tag() -> str: ...
def set_e_tag(value: str) -> None: ...

e_tag = property(get_e_tag, set_e_tag)

Default Value

""

Remarks

This property identifies the state of the event in the calendar. An ETag is returned by the CalDAV server after a successful create_event request. Every time an event is updated, the ETag changes. This gives you the ability to determine if another user has changed the event you added.

You can use this ETag value to maintain a cache. If you submit a get_calendar_report request with the report_filter_return_calendar_data property set to False only the URI and ETags for each event in the calendar will be returned in the report. You can cache the ETag and URI locally, and then inspect the report for any changes and update only the events that have changed ETags.

When updating an event with the create_event method, you may add the ETag to the "If-Match" header (using other_headers) in order to insure that you are not overwriting more recent changes on the server. For instance: calDAV.UID = "20110202T000000Z-6414-500-10112-204@nsoftest"; calDAV.StartDate = "20110202T000000Z"; calDAV.EndDate = "20110202T110000Z"; calDAV.TimeStamp = "20100301T000000Z"; calDAV.Summary = "Dinner with friends"; calDAV.Description = "Getting everyone together for some food and fun"; calDAV.Location = "The James Joyce Irish Pub"; calDAV.EventType = CaldavsEventTypes.vEvent; calDAV.OtherHeaders = "If-Match: 1900-1900\r\ n"; calDAV.CreateEvent "https://caldav.calendar.yahoo.com/dav/user_name/Calendar/My_Calendar/20110202T000000Z-6414-500-10112-204@nsoftest.ics" If the current ETag for the above event is "1900-1900", then the above modification will work perfectly. However, if the event was modified on the Yahoo server, the ETag will not match and the above will fail with an HTTP Protocol error: "409 Conflict". In that case you should retrieve the event with get_event and update the most recent version.

This property is filled from the response to a get_event, and is also used when creating an event to be added using the create_event method. However, when requesting a report using the get_calendar_report method, the contents of this property will only be valid inside the on_event_details event.

event_type Property

Indicates the type of calendar object resource.

Syntax

def get_event_type() -> int: ...
def set_event_type(value: int) -> None: ...

event_type = property(get_event_type, set_event_type)

Default Value

0

Remarks

This property indicates the type of calendar object resource is used.

This property is filled from the response to a get_event, and is also used when creating an event to be added using the create_event method. However, when requesting a report using the get_calendar_report method, the contents of this property will only be valid inside the on_event_details event.

firewall_auto_detect Property

Whether to automatically detect and use firewall system settings, if available.

Syntax

def get_firewall_auto_detect() -> bool: ...
def set_firewall_auto_detect(value: bool) -> None: ...

firewall_auto_detect = property(get_firewall_auto_detect, set_firewall_auto_detect)

Default Value

FALSE

Remarks

Whether to automatically detect and use firewall system settings, if available.

firewall_type Property

The type of firewall to connect through.

Syntax

def get_firewall_type() -> int: ...
def set_firewall_type(value: int) -> None: ...

firewall_type = property(get_firewall_type, set_firewall_type)

Default Value

0

Remarks

The type of firewall to connect through. The applicable values are as follows:

firewall_host Property

The name or IP address of the firewall (optional).

Syntax

def get_firewall_host() -> str: ...
def set_firewall_host(value: str) -> None: ...

firewall_host = property(get_firewall_host, set_firewall_host)

Default Value

""

Remarks

The name or IP address of the firewall (optional). If a firewall_host is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class fails with an error.

firewall_password Property

A password if authentication is to be used when connecting through the firewall.

Syntax

def get_firewall_password() -> str: ...
def set_firewall_password(value: str) -> None: ...

firewall_password = property(get_firewall_password, set_firewall_password)

Default Value

""

Remarks

A password if authentication is to be used when connecting through the firewall. If firewall_host is specified, the firewall_user and firewall_password properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

firewall_port Property

The Transmission Control Protocol (TCP) port for the firewall Host .

Syntax

def get_firewall_port() -> int: ...
def set_firewall_port(value: int) -> None: ...

firewall_port = property(get_firewall_port, set_firewall_port)

Default Value

0

Remarks

The Transmission Control Protocol (TCP) port for the firewall firewall_host. See the description of the firewall_host property for details.

Note: This property is set automatically when firewall_type is set to a valid value. See the description of the firewall_type property for details.

firewall_user Property

A username if authentication is to be used when connecting through a firewall.

Syntax

def get_firewall_user() -> str: ...
def set_firewall_user(value: str) -> None: ...

firewall_user = property(get_firewall_user, set_firewall_user)

Default Value

""

Remarks

A username if authentication is to be used when connecting through a firewall. If firewall_host is specified, this property and the firewall_password property are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.

follow_redirects Property

Determines what happens when the server issues a redirect.

Syntax

def get_follow_redirects() -> int: ...
def set_follow_redirects(value: int) -> None: ...

follow_redirects = property(get_follow_redirects, set_follow_redirects)

Default Value

0

Remarks

This property determines what happens when the server issues a redirect. Normally, the class returns an error if the server responds with an "Object Moved" message. If this property is set to frAlways (1), the new url for the object is retrieved automatically every time.

If this property is set to frSameScheme (2), the new url is retrieved automatically only if the url_scheme is the same; otherwise, the class fails with an error.

Note: Following the HTTP specification, unless this property is set to frAlways (1), automatic redirects will be performed only for GET or HEAD requests. Other methods potentially could change the conditions of the initial request and create security vulnerabilities.

Furthermore, if either the new URL server or port are different from the existing one, user and password are also reset to empty. If, however, this property is set to frAlways (1), the same credentials are used to connect to the new server.

A on_redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the on_redirect event is a good place to set properties related to the new connection (e.g., new authentication parameters).

The default value is frNever (0). In this case, redirects are never followed, and the class fails with an error instead.

free_busy_count Property

The number of records in the FreeBusy arrays.

Syntax

def get_free_busy_count() -> int: ...

free_busy_count = property(get_free_busy_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• free_busy_range
• free_busy_type

The array indices start at 0 and end at free_busy_count - 1.

This property is read-only.

free_busy_range Property

Contains the date/time range when the calendar owner is busy.

Syntax

def get_free_busy_range(free_busy_index: int) -> str: ...

Default Value

""

Remarks

Contains the date/time range when the calendar owner is busy. The format for this property is either "DATETIME/DATETIME" or "DATETIME/DURATION"

The date/time format is "YYYYMMDDThhmmss", where "T" indicates the break between date and time. You may also append a 1-character alpha code for the timezone. For instance, "20100104T123456Z" indicates January 4th, 2010 at 12:34:56 PM UTC.

Durations are represented by the format P<date>T<time>. The date component may contain a number of days or weeks (but not months or years), and the time component may consist of hours, minutes, and seconds. These are represented by an integer value followed by a letter representing the units, as specified by the table below:

This format is based on ISO-8601, but unlike the ISO specification this duration property does not support durations measured in years or months.

The free_busy_index parameter specifies the index of the item in the array. The size of the array is controlled by the free_busy_count property.

This property is read-only.

free_busy_type Property

Indicates the busy status of the corresponding BusyRange .

Syntax

def get_free_busy_type(free_busy_index: int) -> str: ...

Default Value

""

Remarks

Indicates the busy status of the corresponding free_busy_busy_range. A calendar may use custom values for the free_busy_busy_type, but the standard values include:

• BUSY
• FREE
• BUSY-TENTATIVE
• BUSY-UNAVAILABLE

The free_busy_index parameter specifies the index of the item in the array. The size of the array is controlled by the free_busy_count property.

This property is read-only.

idle Property

The current status of the class.

Syntax

def get_idle() -> bool: ...

idle = property(get_idle, None)

Default Value

TRUE

Remarks

This property will be False if the component is currently busy (communicating or waiting for an answer), and True at all other times.

This property is read-only.

last_modified Property

The date and time that the information associated with the calendar event was last revised in the calendar store.

Syntax

def get_last_modified() -> str: ...
def set_last_modified(value: str) -> None: ...

last_modified = property(get_last_modified, set_last_modified)

Default Value

""

Remarks

This property contains the date and time that the information associated with the calendar event was last revised in the calendar store. This is analogous to the modification date and time for a file in the file system, and must be specified in the UTC time format: <date>T<time>Z, where date is in "YYYYMMDD" format and time is in "hhmmss" format. "T" is the delimiter between date and time, and "Z" is the UTC timezone indicator. For example, "20020119T13:23:56Z" is 1:23:56pm on January 19th, 2002. The date/time format is "YYYYMMDDThhmmss", where "T" indicates the break between date and time. You may also append a 1-character alpha code for the timezone. For instance, "20100104T123456Z" indicates January 4th, 2010 at 12:34:56 PM UTC.

This property is filled from the response to a get_event, and is also used when creating an event to be added using the create_event method. However, when requesting a report using the get_calendar_report method, the contents of this property will only be valid inside the on_event_details event.

local_host Property

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

def get_local_host() -> str: ...
def set_local_host(value: str) -> None: ...

local_host = property(get_local_host, set_local_host)

Default Value

""

Remarks

This property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

If the class is connected, the local_host property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

Note: local_host is not persistent. You must always set it in code, and never in the property window.

location Property

Defines the intended venue for the activity defined by a calendar class.

Syntax

def get_location() -> str: ...
def set_location(value: str) -> None: ...

location = property(get_location, set_location)

Default Value

""

Remarks

This property may be used to explicitly specify the venue, such as conference or meeting rooms, for the activity defined by a calendar component. An alternate representation may be specified using a URI that points to directory information with more structured specifications of the location. For example, the alternate representation may specify either an LDAP URL [RFC4516] pointing to an LDAP server entry or a CID URL [RFC2392] pointing to a MIME body part containing a Virtual-Information Card (vCard) [RFC2426] for the location.

This property is filled from the response to a get_event, and is also used when creating an event to be added using the create_event method. However, when requesting a report using the get_calendar_report method, the contents of this property will only be valid inside the on_event_details event.

lock_type Property

The type of the current resource lock.

Syntax

def get_lock_type() -> str: ...
def set_lock_type(value: str) -> None: ...

lock_type = property(get_lock_type, set_lock_type)

Default Value

"write"

Remarks

The type of the current resource lock.

Before the calendar resource can be locked, the lock_type may be set to the type of lock being requested. Currently, the class only supports requesting locks of type "write", although the protocol defines an optional "read" lock. After a successful LockCalendar operation, the class will set the lock_type property to the correct value returned in the server's response.

lock_owner Property

The principle that owns the current resource lock.

Syntax

def get_lock_owner() -> str: ...
def set_lock_owner(value: str) -> None: ...

lock_owner = property(get_lock_owner, set_lock_owner)

Default Value

""

Remarks

The principle that owns the current resource lock.

Before the calendar resource can be locked, the Lock lock_owner may be set to the name of a principle or group of principles that will own the lock. If no owner is specified, the server will automatically associate the lock with the requesting principle. After a successful LockCalendar operation, the class will set the lock_owner property to the correct value returned in the server's response.

lock_scope Property

The scope of the current resource lock.

Syntax

def get_lock_scope() -> str: ...
def set_lock_scope(value: str) -> None: ...

lock_scope = property(get_lock_scope, set_lock_scope)

Default Value

""

Remarks

The scope of the current resource lock.

Before the calendar resource can be locked, the Lock lock_scope may be set to the type of scope needed for the lock. Currently the class will only allow two types of scopes to be requested:

If no scope is specified, the protocol default scope, "exclusive", will be requested. After a successful LockCalendar operation, the class will set the lock_scope property to the correct value returned in the server's response.

lock_timeout Property

The time to live for the current resource lock.

Syntax

def get_lock_timeout() -> int: ...
def set_lock_timeout(value: int) -> None: ...

lock_timeout = property(get_lock_timeout, set_lock_timeout)

Default Value

0

Remarks

The time to live for the current resource lock.

Before the calendar resource can be locked, the Lock lock_timeout may be set to a specific amount of time needed for the locked operation to take place. The timeout is used to determine how long the lock may exist before the server automatically unlocks the resource URI. If lock_timeout of 0 is specified, the server will use a default timeout. After a successful LockCalendar operation, the class will set the Lock lock_timeout property to the correct value returned in the server's response.

lock_token Property

The lock string to be used when submitting operations on a locked resource.

Syntax

def get_lock_token() -> str: ...
def set_lock_token(value: str) -> None: ...

lock_token = property(get_lock_token, set_lock_token)

Default Value

""

Remarks

The lock string to be used when submitting operations on a locked resource.

Before the calendar resource can be locked, the Lock lock_token may be set to the token returned by a previous lock operation. This is useful when renewing a timeout. The server will respond with a new timeout value, which will be stored in lock_timeout. If the lock request is not a lock refresh, lock_token must be empty, and will be parsed out of the server response after a successful LockCalendar operation.

organizer Property

Defines the organizer of a calendar event.

Syntax

def get_organizer() -> str: ...
def set_organizer(value: str) -> None: ...

organizer = property(get_organizer, set_organizer)

Default Value

""

Remarks

This property is specified within the vEvent, vTodo, and vJournal calendar event_types to specify the organizer of a group-scheduled calendar entity. The property is specified within the vFreeBusy event_type to identify the calendar user requesting the free or busy time. When publishing a vFreeBusy event_type, the property is used to specify the calendar that the published busy time came from.

Each email address should be in the mailto URI format (as defined in RFC2368).

For instance: CalDAV.Organizer = "mailto:jane_doe@example.com";

This property is filled from the response to a get_event, and is also used when creating an event to be added using the create_event method. However, when requesting a report using the get_calendar_report method, the contents of this property will only be valid inside the on_event_details event.

other_headers Property

Other headers as determined by the user (optional).

Syntax

def get_other_headers() -> str: ...
def set_other_headers(value: str) -> None: ...

other_headers = property(get_other_headers, set_other_headers)

Default Value

""

Remarks

This property can be set to a string of headers to be appended to the HTTP request headers created from other properties like content_type and from_.

The headers must follow the format Header: Value as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") .

Use this property with caution. If this property contains invalid headers, HTTP requests may fail.

This property is useful for extending the functionality of the class beyond what is provided.

For CalDAV, the "If-Match" header is extremely useful. After adding a an event with create_event or retrieving an event with get_event, the e_tag property will contain a value indicating the current state of the event. If you wish to update the event, you may pass this returned e_tag in an "If-Match" header. If the event on the server has been modified since you retrieved it (and the ETag on the server has changed), then the create_event will fail with an HTTP Protocol Error: "409 Conflict", which indicates there is a conflict between the version you're trying to update and the current version on the sever. For instance: calDAV.OtherHeaders = "If-Match: 1900-1900\r\ n";

parsed_header_count Property

The number of records in the ParsedHeader arrays.

Syntax

def get_parsed_header_count() -> int: ...

parsed_header_count = property(get_parsed_header_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• parsed_header_field
• parsed_header_value

The array indices start at 0 and end at parsed_header_count - 1.

This property is read-only.

parsed_header_field Property

This property contains the name of the HTTP header (this is the same case as it is delivered).

Syntax

def get_parsed_header_field(parsed_header_index: int) -> str: ...

Default Value

""

Remarks

This property contains the name of the HTTP Header (this is the same case as it is delivered).

The parsed_header_index parameter specifies the index of the item in the array. The size of the array is controlled by the parsed_header_count property.

This property is read-only.

parsed_header_value Property

This property contains the header contents.

Syntax

def get_parsed_header_value(parsed_header_index: int) -> str: ...

Default Value

""

Remarks

This property contains the Header contents.

The parsed_header_index parameter specifies the index of the item in the array. The size of the array is controlled by the parsed_header_count property.

This property is read-only.

password Property

This property includes a password if authentication is to be used.

Syntax

def get_password() -> str: ...
def set_password(value: str) -> None: ...

password = property(get_password, set_password)

Default Value

""

Remarks

This property contains a password if authentication is to be used. If auth_scheme is set to HTTP Basic Authentication, the user and password are Base64 encoded and the result is put in the Authorization configuration setting in the form "Basic [encoded-user-password]".

If auth_scheme is set to HTTP Digest Authentication, the user and password properties are used to respond to the HTTP Digest Authentication challenge from the server.

If auth_scheme is set to NTLM, NTLM authentication will be attempted. If auth_scheme is set to NTLM and user and password are empty, the class will attempt to authenticate using the current user's credentials.

priority Property

Defines the relative priority for a calendar event.

Syntax

def get_priority() -> int: ...
def set_priority(value: int) -> None: ...

priority = property(get_priority, set_priority)

Default Value

0

Remarks

This property defines the relative priority of a calendar event. The priority is specified as an integer in the range 0 to 9. A value of 0 specifies an undefined priority. A value of 1 is the highest priority. A value of 2 is the second highest priority. Subsequent numbers specify a decreasing ordinal priority. A value of 9 is the lowest priority.

A Calendar User-Agent (CUA) with a three-level priority scheme of "HIGH", "MEDIUM", and "LOW" is mapped into this property such that a property value in the range of 1 to 4 specifies "HIGH" priority. A value of 5 is the normal or "MEDIUM" priority. A value in the range of 6 to 9 is "LOW" priority.

This property is filled from the response to a get_event, and is also used when creating an event to be added using the create_event method. However, when requesting a report using the get_calendar_report method, the contents of this property will only be valid inside the on_event_details event.

proxy_auth_scheme Property

The type of authorization to perform when connecting to the proxy.

Syntax

def get_proxy_auth_scheme() -> int: ...
def set_proxy_auth_scheme(value: int) -> None: ...

proxy_auth_scheme = property(get_proxy_auth_scheme, set_proxy_auth_scheme)

Default Value

0

Remarks

The type of authorization to perform when connecting to the proxy. This is used only when the proxy_user and proxy_password properties are set.

proxy_auth_scheme should be set to authNone (3) when no authentication is expected.

By default, proxy_auth_scheme is authBasic (0), and if the proxy_user and proxy_password properties are set, the class will attempt basic authentication.

If proxy_auth_scheme is set to authDigest (1), digest authentication will be attempted instead.

If proxy_auth_scheme is set to authProprietary (2), then the authorization token will not be generated by the class. Look at the configuration file for the class being used to find more information about manually setting this token.

If proxy_auth_scheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of proxy_user and proxy_password.

proxy_auto_detect Property

Whether to automatically detect and use proxy system settings, if available.

Syntax

def get_proxy_auto_detect() -> bool: ...
def set_proxy_auto_detect(value: bool) -> None: ...

proxy_auto_detect = property(get_proxy_auto_detect, set_proxy_auto_detect)

Default Value

FALSE

Remarks

Whether to automatically detect and use proxy system settings, if available. The default value is False.

proxy_password Property

A password if authentication is to be used for the proxy.

Syntax

def get_proxy_password() -> str: ...
def set_proxy_password(value: str) -> None: ...

proxy_password = property(get_proxy_password, set_proxy_password)

Default Value

""

Remarks

A password if authentication is to be used for the proxy.

If proxy_auth_scheme is set to Basic Authentication, the proxy_user and proxy_password properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If proxy_auth_scheme is set to Digest Authentication, the proxy_user and proxy_password properties are used to respond to the Digest Authentication challenge from the server.

If proxy_auth_scheme is set to NTLM Authentication, the proxy_user and proxy_password properties are used to authenticate through NTLM negotiation.

proxy_port Property

The Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

def get_proxy_port() -> int: ...
def set_proxy_port(value: int) -> None: ...

proxy_port = property(get_proxy_port, set_proxy_port)

Default Value

80

Remarks

The Transmission Control Protocol (TCP) port for the proxy proxy_server (default 80). See the description of the proxy_server property for details.

proxy_server Property

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

Syntax

def get_proxy_server() -> str: ...
def set_proxy_server(value: str) -> None: ...

proxy_server = property(get_proxy_server, set_proxy_server)

Default Value

""

Remarks

If a proxy proxy_server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the proxy_server property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the proxy_server property is set to the corresponding address. If the search is not successful, an error is returned.

proxy_ssl Property

When to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

def get_proxy_ssl() -> int: ...
def set_proxy_ssl(value: int) -> None: ...

proxy_ssl = property(get_proxy_ssl, set_proxy_ssl)

Default Value

0

Remarks

When to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

proxy_user Property

A username if authentication is to be used for the proxy.

Syntax

def get_proxy_user() -> str: ...
def set_proxy_user(value: str) -> None: ...

proxy_user = property(get_proxy_user, set_proxy_user)

Default Value

""

Remarks

A username if authentication is to be used for the proxy.

If proxy_auth_scheme is set to Basic Authentication, the proxy_user and proxy_password properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If proxy_auth_scheme is set to Digest Authentication, the proxy_user and proxy_password properties are used to respond to the Digest Authentication challenge from the server.

If proxy_auth_scheme is set to NTLM Authentication, the proxy_user and proxy_password properties are used to authenticate through NTLM negotiation.

recurrence_dates Property

Individual dates on which the event will recur.

Syntax

def get_recurrence_dates() -> str: ...
def set_recurrence_dates(value: str) -> None: ...

recurrence_dates = property(get_recurrence_dates, set_recurrence_dates)

Default Value

""

Remarks

Individual dates on which the event will recur.

This property is used if you wish to denote specific, individual dates on which the event recurs. If you have an event that occurs monthly or weekly or on some other time interval, use the recurrence_rule property instead.

This property is filled after retrieving a calendar event, and is also used to create an event to put on the server. However, when requesting a report the contents of this property will only be valid inside the CalDAV EventDetails event.

recurrence_exception_dates Property

Defines the list of DATE-TIME exceptions to the recurrence set.

Syntax

def get_recurrence_exception_dates() -> str: ...
def set_recurrence_exception_dates(value: str) -> None: ...

recurrence_exception_dates = property(get_recurrence_exception_dates, set_recurrence_exception_dates)

Default Value

""

Remarks

Defines the list of DATE-TIME exceptions to the recurrence set.

If the recurrence_exception_dates and recurrence_exception_rule are specified, they are used in computing the recurrence set. The recurrence set is the complete set of recurrence instances for a calendar component. The recurrence set is generated by considering the initial start_date property along with the recurrence_rule, recurrence_dates, recurrence_exception_rule, and recurrence_exception_dates properties contained within the recurring event. The start_date property defines the first instance in the recurrence set. The starting date SHOULD match the pattern of the recurrence rule, if specified. The recurrence set generated with a start date that doesn't match the pattern of the rule is undefined. The final recurrence set is generated by gathering all of the start DATE-TIME values generated by any of the specified recurrence_rule and recurrence_dates properties, and then excluding any start DATE-TIME values specified by the recurrence_exception_rule or recurrence_exception_dates properties. This implies that DATE-TIME values specified by the recurrence_exception_rule and recurrence_exception_dates properties take precedence over those specified by inclusion properties (i.e., recurrence_dates and recurrence_rule). When duplicate instances are generated by the recurrence recurrence_rule and recurrence_dates properties, only one recurrence is considered. Duplicate instances are ignored.

The date/time format is "YYYYMMDDThhmmss", where "T" indicates the break between date and time. You may also append a 1-character alpha code for the timezone. For instance, "20100104T123456Z" indicates January 4th, 2010 at 12:34:56 PM UTC.

This property is filled after retrieving a calendar event, and is also used to create an event to put on the server. However, when requesting a report the contents of this property will only be valid inside the CalDAV EventDetails event.

recurrence_exception_rule Property

Defines a rule or repeating pattern for an exception to the recurrence set.

Syntax

def get_recurrence_exception_rule() -> str: ...
def set_recurrence_exception_rule(value: str) -> None: ...

recurrence_exception_rule = property(get_recurrence_exception_rule, set_recurrence_exception_rule)

Default Value

""

Remarks

Defines a rule or repeating pattern for an exception to the recurrence set.

If the recurrence_exception_dates and recurrence_exception_rule are specified, they are used in computing the recurrence set. The recurrence set is the complete set of recurrence instances for a calendar component. The recurrence set is generated by considering the initial start_date property along with the recurrence_rule, recurrence_dates, recurrence_exception_rule, and recurrence_exception_dates properties contained within the recurring event. The start_date property defines the first instance in the recurrence set. The starting date SHOULD match the pattern of the recurrence rule, if specified. The recurrence set generated with a start date that doesn't match the pattern of the rule is undefined. The final recurrence set is generated by gathering all of the start DATE-TIME values generated by any of the specified recurrence_rule and recurrence_dates properties, and then excluding any start DATE-TIME values specified by the recurrence_exception_rule or recurrence_exception_dates properties. This implies that DATE-TIME values specified by the recurrence_exception_rule and recurrence_exception_dates properties take precedence over those specified by inclusion properties (i.e., recurrence_dates and recurrence_rule). When duplicate instances are generated by the recurrence recurrence_rule and recurrence_dates properties, only one recurrence is considered. Duplicate instances are ignored.

This value type is a structured value consisting of a list of one or more recurrence grammar parts. Each rule part is defined by a NAME=VALUE pair. The rule parts are separated from each other by the SEMICOLON character. The rule parts are not ordered in any particular sequence. Individual rule parts MUST only be specified once.

The table below shows the supported rules and their usage.

Information not contained in the recurrence_rule necessary to determine the various recurrence instance start time and dates are derived from the start_date property. For example, "FREQ=YEARLY;BYMONTH=1" doesn't specify a specific day within the month or a time. This information would be the same as what is specified for the start_date property.

BYxxx rule parts modify the recurrence in some manner. BYxxx rule parts for a period of time that is the same or greater than the frequency generally reduce or limit the number of occurrences of the recurrence generated. For example, "FREQ=DAILY;BYMONTH=1" reduces the number of recurrence instances from all days (if BYMONTH rule part is not present) to all days in January. BYxxx rule parts for a period of time less than the frequency generally increase or expand the number of occurrences of the recurrence. For example, "FREQ=YEARLY;BYMONTH=1,2" increases the number of days within the yearly recurrence set from 1 (if BYMONTH rule part is not present) to 2.

If multiple BYxxx rule parts are specified, then after evaluating the specified FREQ and INTERVAL rule parts, the BYxxx rule parts are applied to the current set of evaluated occurrences in the following order: BYMONTH, BYWEEKNO, BYYEARDAY, BYMONTHDAY, BYDAY, BYHOUR, BYMINUTE, BYSECOND and BYSETPOS; then COUNT and UNTIL are evaluated.

This property is filled after retrieving a calendar event, and is also used to create an event to put on the server. However, when requesting a report the contents of this property will only be valid inside the CalDAV EventDetails event.

recurrence_id Property

Identifies a recurring event.

Syntax

def get_recurrence_id() -> str: ...
def set_recurrence_id(value: str) -> None: ...

recurrence_id = property(get_recurrence_id, set_recurrence_id)

Default Value

""

Remarks

Identifies a recurring event.

This property is used in conjunction with the CalDAV UID and Sequence properties to identify a specific instance of a recurring event, todo, or journal. The value of this property is the value of the CalDAV StartDate property of the original recurrence instance.

This property is filled after retrieving a calendar event, and is also used to create an event to put on the server. However, when requesting a report the contents of this property will only be valid inside the CalDAV EventDetails event.

recurrence_rule Property

This property defines the recurrence rule for the event.

Syntax

def get_recurrence_rule() -> str: ...
def set_recurrence_rule(value: str) -> None: ...

recurrence_rule = property(get_recurrence_rule, set_recurrence_rule)

Default Value

""

Remarks

This property defines the recurrence rule for the event.

This value type is a structured value consisting of a list of one or more recurrence grammar parts. Each rule part is defined by a NAME=VALUE pair. The rule parts are separated from each other by the SEMICOLON character. The rule parts are not ordered in any particular sequence. Individual rule parts MUST only be specified once.

The table below shows the supported rules and their usage.

Information not contained in the recurrence_rule necessary to determine the various recurrence instance start time and dates are derived from the start_date property. For example, "FREQ=YEARLY;BYMONTH=1" doesn't specify a specific day within the month or a time. This information would be the same as what is specified for the start_date property.

BYxxx rule parts modify the recurrence in some manner. BYxxx rule parts for a period of time that is the same or greater than the frequency generally reduce or limit the number of occurrences of the recurrence generated. For example, "FREQ=DAILY;BYMONTH=1" reduces the number of recurrence instances from all days (if BYMONTH rule part is not present) to all days in January. BYxxx rule parts for a period of time less than the frequency generally increase or expand the number of occurrences of the recurrence. For example, "FREQ=YEARLY;BYMONTH=1,2" increases the number of days within the yearly recurrence set from 1 (if BYMONTH rule part is not present) to 2.

If multiple BYxxx rule parts are specified, then after evaluating the specified FREQ and INTERVAL rule parts, the BYxxx rule parts are applied to the current set of evaluated occurrences in the following order: BYMONTH, BYWEEKNO, BYYEARDAY, BYMONTHDAY, BYDAY, BYHOUR, BYMINUTE, BYSECOND and BYSETPOS; then COUNT and UNTIL are evaluated.

This property is filled after retrieving a calendar event, and is also used to create an event to put on the server. However, when requesting a report the contents of this property will only be valid inside the CalDAV EventDetails event.

related_to Property

Represents a relationship or reference between this calendar event and another.

Syntax

def get_related_to() -> str: ...
def set_related_to(value: str) -> None: ...

related_to = property(get_related_to, set_related_to)

Default Value

""

Remarks

This property is specified within the vEvent, vTodo, and vJournal calendar event_types to represent a relationship or reference between this calendar component and another. This value would be represented by the uid property of the event, which this event is related to. The related_to value points to another calendar component that has a PARENT relationship to the referencing object.

report_filter_alarm_end Property

Limits the events returned in the report to only those with an alarm set in the range specified by AlarmStart and AlarmEnd .

Syntax

def get_report_filter_alarm_end() -> str: ...
def set_report_filter_alarm_end(value: str) -> None: ...

report_filter_alarm_end = property(get_report_filter_alarm_end, set_report_filter_alarm_end)

Default Value

""

Remarks

Limits the events returned in the report to only those with an alarm set in the range specified by report_filter_alarm_start and report_filter_alarm_end. The date/time format is "YYYYMMDDThhmmss", where "T" indicates the break between date and time. You may also append a 1-character alpha code for the timezone. For instance, "20100104T123456Z" indicates January 4th, 2010 at 12:34:56 PM UTC.

report_filter_alarm_start Property

Limits the events returned in the report to only those with an alarm set in the range specified by AlarmStart and AlarmEnd .

Syntax

def get_report_filter_alarm_start() -> str: ...
def set_report_filter_alarm_start(value: str) -> None: ...

report_filter_alarm_start = property(get_report_filter_alarm_start, set_report_filter_alarm_start)

Default Value

""

Remarks

Limits the events returned in the report to only those with an alarm set in the range specified by report_filter_alarm_start and report_filter_alarm_end. The date/time format is "YYYYMMDDThhmmss", where "T" indicates the break between date and time. You may also append a 1-character alpha code for the timezone. For instance, "20100104T123456Z" indicates January 4th, 2010 at 12:34:56 PM UTC.

report_filter_custom_filter Property

Allows the user to specify his own filter XML.

Syntax

def get_report_filter_custom_filter() -> str: ...
def set_report_filter_custom_filter(value: str) -> None: ...

report_filter_custom_filter = property(get_report_filter_custom_filter, set_report_filter_custom_filter)

Default Value

""

Remarks

Allows the user to specify his own filter XML. This property must be properly-formed XML, and must be a supported CalDAV filter or the class fails with an error.

report_filter_end_date Property

Limits the events returned in the report to only those which occur in the time range specified by StartDate and EndDate .

Syntax

def get_report_filter_end_date() -> str: ...
def set_report_filter_end_date(value: str) -> None: ...

report_filter_end_date = property(get_report_filter_end_date, set_report_filter_end_date)

Default Value

""

Remarks

Limits the events returned in the report to only those which occur in the time range specified by report_filter_start_date and report_filter_end_date. The date/time format is "YYYYMMDDThhmmss", where "T" indicates the break between date and time. You may also append a 1-character alpha code for the timezone. For instance, "20100104T123456Z" indicates January 4th, 2010 at 12:34:56 PM UTC.

report_filter_event_type Property

Indicates the type of calendar object resources to return in a Report.

Syntax

def get_report_filter_event_type() -> int: ...
def set_report_filter_event_type(value: int) -> None: ...

report_filter_event_type = property(get_report_filter_event_type, set_report_filter_event_type)

Default Value

0

Remarks

Indicates the type of calendar object resources to return in a Report. Some calendar servers (Google in particular) do not support vtAll, so you must submit a report for each type of event you wish to retrieve a report on.

report_filter_property Property

Limits the events returned in a Report to only those which contain a matching property name and value.

Syntax

def get_report_filter_property() -> str: ...
def set_report_filter_property(value: str) -> None: ...

report_filter_property = property(get_report_filter_property, set_report_filter_property)

Default Value

""

Remarks

Limits the events returned in a Report to only those which contain a matching property name and value. For instance, setting the report_filter_property filter to "ORGANIZER" will return only events that have an organizer specified. Setting the report_filter_property filter to "ORGANIZER=mailto:JohnSmith@example.com" will return only resources where "mailto:JohnSmith@example.com" is the specified organizer. Likewise, you can retrieve a report on a single event by setting the report_filter_property filter with the UID of the needed resource. For example: report_filter_property = "UID=DC6C50A017428C5216A2F1CD@example.com";.

You may add multiple properties to the filter by separating them with commas. For example: "ORGANIZER=mailto:JohnSmith@example.com, STATUS=CANCELLED".

For more advanced filtering, you may specify your own report_filter_custom_filter.

report_filter_recur_end Property

Limits the recurring events returned in the report.

Syntax

def get_report_filter_recur_end() -> str: ...
def set_report_filter_recur_end(value: str) -> None: ...

report_filter_recur_end = property(get_report_filter_recur_end, set_report_filter_recur_end)

Default Value

""

Remarks

Limits the recurring events returned in the report.

Use of the CalDAV limit-recurrence-set element causes the server to only return overridden recurrence components that overlap the time range specified by report_filter_recur_start and report_filter_recur_end or that affect other instances that overlap the time range specified by report_filter_start_date and report_filter_end_date. The date/time format is "YYYYMMDDThhmmss", where "T" indicates the break between date and time. You may also append a 1-character alpha code for the timezone. For instance, "20100104T123456Z" indicates January 4th, 2010 at 12:34:56 PM UTC.

Note that the report_filter_recur_end property cannot be used when report_filter_return_calendar_data is False.

report_filter_recur_start Property

Limits the recurring events returned in the report.

Syntax

def get_report_filter_recur_start() -> str: ...
def set_report_filter_recur_start(value: str) -> None: ...

report_filter_recur_start = property(get_report_filter_recur_start, set_report_filter_recur_start)

Default Value

""

Remarks

Limits the recurring events returned in the report.

Use of the CalDAV limit-recurrence-set element causes the server to only return overridden recurrence components that overlap the time range specified by report_filter_recur_start and report_filter_recur_end or that affect other instances that overlap the time range specified by report_filter_start_date and report_filter_end_date. The date/time format is "YYYYMMDDThhmmss", where "T" indicates the break between date and time. You may also append a 1-character alpha code for the timezone. For instance, "20100104T123456Z" indicates January 4th, 2010 at 12:34:56 PM UTC.

Note that the report_filter_recur_start property cannot be used when report_filter_return_calendar_data is False.

report_filter_return_calendar_data Property

Controls whether the contents of each calendar event is returned in the report.

Syntax

def get_report_filter_return_calendar_data() -> bool: ...
def set_report_filter_return_calendar_data(value: bool) -> None: ...

report_filter_return_calendar_data = property(get_report_filter_return_calendar_data, set_report_filter_return_calendar_data)

Default Value

TRUE

Remarks

Controls whether the contents of each calendar event is returned in the report.

If report_filter_return_calendar_data is True (default), a report will contain the full contents of each event in the calendar. This can be a substantially large amount of data. However if report_filter_return_calendar_data is False, the report returned will contain only URIs and ETags of each calendar event. You may compare the URIs against a cached list and retrieve any new URIs individually via the CalDAV.GetCalendarEvent method. If the ETag for a cached URI has changed, it means that the calendar event has changed, and needs to be retrieved.

Note that this filter is not compatible with the report_filter_recur_start and report_filter_recur_end properties.

report_filter_start_date Property

Limits the events returned in the report to only those which occur in the time range specified by StartDate and EndDate .

Syntax

def get_report_filter_start_date() -> str: ...
def set_report_filter_start_date(value: str) -> None: ...

report_filter_start_date = property(get_report_filter_start_date, set_report_filter_start_date)

Default Value

""

Remarks

Limits the events returned in the report to only those which occur in the time range specified by report_filter_start_date and report_filter_end_date. The date/time format is "YYYYMMDDThhmmss", where "T" indicates the break between date and time. You may also append a 1-character alpha code for the timezone. For instance, "20100104T123456Z" indicates January 4th, 2010 at 12:34:56 PM UTC.

report_filter_uid Property

Limits the recurring events returned in the report to only those with the specified UID.

Syntax

def get_report_filter_uid() -> str: ...
def set_report_filter_uid(value: str) -> None: ...

report_filter_uid = property(get_report_filter_uid, set_report_filter_uid)

Default Value

""

Remarks

Limits the recurring events returned in the report to only those with the specified UID.

sequence Property

Defines the revision sequence number of the event within a sequence of revisions.

Syntax

def get_sequence() -> int: ...
def set_sequence(value: int) -> None: ...

sequence = property(get_sequence, set_sequence)

Default Value

0

Remarks

This property defines the revision sequence number of the event within a sequence of revisions. When a calendar component is created its sequence number is 0. It is incremented by the organizer's Calendar User Agent (CUA) each time the organizer makes a significant revision to the calendar event. Therefore, a sequence number of 2 means the event has been revised twice.

The organizer includes this property in a calendar event that it sends to an attendees to specify the current version of the event. Likewise, the attendees includes this property in an event that it sends to the organizer to specify the version of the calendar component to which the attendees is referring.

Note: Recurrence instances of a recurring event may have different sequence numbers.

This property is filled from the response to a get_event, and is also used when creating an event to be added using the create_event method. However, when requesting a report using the get_calendar_report method, the contents of this property will only be valid inside the on_event_details event.

ssl_accept_server_cert_effective_date Property

The date on which this certificate becomes valid.

Syntax

def get_ssl_accept_server_cert_effective_date() -> str: ...

ssl_accept_server_cert_effective_date = property(get_ssl_accept_server_cert_effective_date, None)

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

ssl_accept_server_cert_expiration_date Property

The date on which the certificate expires.

Syntax

def get_ssl_accept_server_cert_expiration_date() -> str: ...

ssl_accept_server_cert_expiration_date = property(get_ssl_accept_server_cert_expiration_date, None)

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

ssl_accept_server_cert_extended_key_usage Property

A comma-delimited list of extended key usage identifiers.

Syntax

def get_ssl_accept_server_cert_extended_key_usage() -> str: ...

ssl_accept_server_cert_extended_key_usage = property(get_ssl_accept_server_cert_extended_key_usage, None)

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

ssl_accept_server_cert_fingerprint Property

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

def get_ssl_accept_server_cert_fingerprint() -> str: ...

ssl_accept_server_cert_fingerprint = property(get_ssl_accept_server_cert_fingerprint, None)

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

ssl_accept_server_cert_fingerprint_sha1 Property

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

def get_ssl_accept_server_cert_fingerprint_sha1() -> str: ...

ssl_accept_server_cert_fingerprint_sha1 = property(get_ssl_accept_server_cert_fingerprint_sha1, None)

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

ssl_accept_server_cert_fingerprint_sha256 Property

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

def get_ssl_accept_server_cert_fingerprint_sha256() -> str: ...

ssl_accept_server_cert_fingerprint_sha256 = property(get_ssl_accept_server_cert_fingerprint_sha256, None)

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

ssl_accept_server_cert_issuer Property

The issuer of the certificate.

Syntax

def get_ssl_accept_server_cert_issuer() -> str: ...

ssl_accept_server_cert_issuer = property(get_ssl_accept_server_cert_issuer, None)

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

ssl_accept_server_cert_private_key Property

The private key of the certificate (if available).

Syntax

def get_ssl_accept_server_cert_private_key() -> str: ...

ssl_accept_server_cert_private_key = property(get_ssl_accept_server_cert_private_key, None)

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The ssl_accept_server_cert_private_key may be available but not exportable. In this case, ssl_accept_server_cert_private_key returns an empty string.

This property is read-only.

ssl_accept_server_cert_private_key_available Property

Whether a PrivateKey is available for the selected certificate.

Syntax

def get_ssl_accept_server_cert_private_key_available() -> bool: ...

ssl_accept_server_cert_private_key_available = property(get_ssl_accept_server_cert_private_key_available, None)

Default Value

FALSE

Remarks

Whether a ssl_accept_server_cert_private_key is available for the selected certificate. If ssl_accept_server_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

ssl_accept_server_cert_private_key_container Property

The name of the PrivateKey container for the certificate (if available).

Syntax

def get_ssl_accept_server_cert_private_key_container() -> str: ...

ssl_accept_server_cert_private_key_container = property(get_ssl_accept_server_cert_private_key_container, None)

Default Value

""

Remarks

The name of the ssl_accept_server_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

ssl_accept_server_cert_public_key Property

The public key of the certificate.

Syntax

def get_ssl_accept_server_cert_public_key() -> str: ...

ssl_accept_server_cert_public_key = property(get_ssl_accept_server_cert_public_key, None)

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

ssl_accept_server_cert_public_key_algorithm Property

The textual description of the certificate's public key algorithm.

Syntax

def get_ssl_accept_server_cert_public_key_algorithm() -> str: ...

ssl_accept_server_cert_public_key_algorithm = property(get_ssl_accept_server_cert_public_key_algorithm, None)

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

ssl_accept_server_cert_public_key_length Property

The length of the certificate's public key (in bits).

Syntax

def get_ssl_accept_server_cert_public_key_length() -> int: ...

ssl_accept_server_cert_public_key_length = property(get_ssl_accept_server_cert_public_key_length, None)

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

ssl_accept_server_cert_serial_number Property

The serial number of the certificate encoded as a string.

Syntax

def get_ssl_accept_server_cert_serial_number() -> str: ...

ssl_accept_server_cert_serial_number = property(get_ssl_accept_server_cert_serial_number, None)

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

ssl_accept_server_cert_signature_algorithm Property

The text description of the certificate's signature algorithm.

Syntax

def get_ssl_accept_server_cert_signature_algorithm() -> str: ...

ssl_accept_server_cert_signature_algorithm = property(get_ssl_accept_server_cert_signature_algorithm, None)

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

ssl_accept_server_cert_store Property

The name of the certificate store for the client certificate.

Syntax

def get_ssl_accept_server_cert_store() -> bytes: ...
def set_ssl_accept_server_cert_store(value: bytes) -> None: ...

ssl_accept_server_cert_store = property(get_ssl_accept_server_cert_store, set_ssl_accept_server_cert_store)

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The ssl_accept_server_cert_store_type property denotes the type of the certificate store specified by ssl_accept_server_cert_store. If the store is password-protected, specify the password in ssl_accept_server_cert_store_password.

ssl_accept_server_cert_store is used in conjunction with the ssl_accept_server_cert_subject property to specify client certificates. If ssl_accept_server_cert_store has a value, and ssl_accept_server_cert_subject or ssl_accept_server_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_accept_server_cert_subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

ssl_accept_server_cert_store_password Property

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

def get_ssl_accept_server_cert_store_password() -> str: ...
def set_ssl_accept_server_cert_store_password(value: str) -> None: ...

ssl_accept_server_cert_store_password = property(get_ssl_accept_server_cert_store_password, set_ssl_accept_server_cert_store_password)

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

ssl_accept_server_cert_store_type Property

The type of certificate store for this certificate.

Syntax

def get_ssl_accept_server_cert_store_type() -> int: ...
def set_ssl_accept_server_cert_store_type(value: int) -> None: ...

ssl_accept_server_cert_store_type = property(get_ssl_accept_server_cert_store_type, set_ssl_accept_server_cert_store_type)

Default Value

0

Remarks

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

ssl_accept_server_cert_subject_alt_names Property

Comma-separated lists of alternative subject names for the certificate.

Syntax

def get_ssl_accept_server_cert_subject_alt_names() -> str: ...

ssl_accept_server_cert_subject_alt_names = property(get_ssl_accept_server_cert_subject_alt_names, None)

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

ssl_accept_server_cert_thumbprint_md5 Property

The MD5 hash of the certificate.

Syntax

def get_ssl_accept_server_cert_thumbprint_md5() -> str: ...

ssl_accept_server_cert_thumbprint_md5 = property(get_ssl_accept_server_cert_thumbprint_md5, None)

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_accept_server_cert_thumbprint_sha1 Property

The SHA-1 hash of the certificate.

Syntax

def get_ssl_accept_server_cert_thumbprint_sha1() -> str: ...

ssl_accept_server_cert_thumbprint_sha1 = property(get_ssl_accept_server_cert_thumbprint_sha1, None)

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_accept_server_cert_thumbprint_sha256 Property

The SHA-256 hash of the certificate.

Syntax

def get_ssl_accept_server_cert_thumbprint_sha256() -> str: ...

ssl_accept_server_cert_thumbprint_sha256 = property(get_ssl_accept_server_cert_thumbprint_sha256, None)

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_accept_server_cert_usage Property

The text description of UsageFlags .

Syntax

def get_ssl_accept_server_cert_usage() -> str: ...

ssl_accept_server_cert_usage = property(get_ssl_accept_server_cert_usage, None)

Default Value

""

Remarks

The text description of ssl_accept_server_cert_usage_flags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

ssl_accept_server_cert_usage_flags Property

The flags that show intended use for the certificate.

Syntax

def get_ssl_accept_server_cert_usage_flags() -> int: ...

ssl_accept_server_cert_usage_flags = property(get_ssl_accept_server_cert_usage_flags, None)

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of ssl_accept_server_cert_usage_flags is a combination of the following flags:

Please see the ssl_accept_server_cert_usage property for a text representation of ssl_accept_server_cert_usage_flags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

ssl_accept_server_cert_version Property

The certificate's version number.

Syntax

def get_ssl_accept_server_cert_version() -> str: ...

ssl_accept_server_cert_version = property(get_ssl_accept_server_cert_version, None)

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

ssl_accept_server_cert_subject Property

The subject of the certificate used for client authentication.

Syntax

def get_ssl_accept_server_cert_subject() -> str: ...
def set_ssl_accept_server_cert_subject(value: str) -> None: ...

ssl_accept_server_cert_subject = property(get_ssl_accept_server_cert_subject, set_ssl_accept_server_cert_subject)

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

ssl_accept_server_cert_encoded Property

The certificate (PEM/Base64 encoded).

Syntax

def get_ssl_accept_server_cert_encoded() -> bytes: ...
def set_ssl_accept_server_cert_encoded(value: bytes) -> None: ...

ssl_accept_server_cert_encoded = property(get_ssl_accept_server_cert_encoded, set_ssl_accept_server_cert_encoded)

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_accept_server_cert_store and ssl_accept_server_cert_subject properties also may be used to specify a certificate.

When ssl_accept_server_cert_encoded is set, a search is initiated in the current ssl_accept_server_cert_store for the private key of the certificate. If the key is found, ssl_accept_server_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_accept_server_cert_subject is set to an empty string.

ssl_cert_effective_date Property

The date on which this certificate becomes valid.

Syntax

def get_ssl_cert_effective_date() -> str: ...

ssl_cert_effective_date = property(get_ssl_cert_effective_date, None)

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

ssl_cert_expiration_date Property

The date on which the certificate expires.

Syntax

def get_ssl_cert_expiration_date() -> str: ...

ssl_cert_expiration_date = property(get_ssl_cert_expiration_date, None)

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

ssl_cert_extended_key_usage Property

A comma-delimited list of extended key usage identifiers.

Syntax

def get_ssl_cert_extended_key_usage() -> str: ...

ssl_cert_extended_key_usage = property(get_ssl_cert_extended_key_usage, None)

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

ssl_cert_fingerprint Property

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

def get_ssl_cert_fingerprint() -> str: ...

ssl_cert_fingerprint = property(get_ssl_cert_fingerprint, None)

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

ssl_cert_fingerprint_sha1 Property

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

def get_ssl_cert_fingerprint_sha1() -> str: ...

ssl_cert_fingerprint_sha1 = property(get_ssl_cert_fingerprint_sha1, None)

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

ssl_cert_fingerprint_sha256 Property

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

def get_ssl_cert_fingerprint_sha256() -> str: ...

ssl_cert_fingerprint_sha256 = property(get_ssl_cert_fingerprint_sha256, None)

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

ssl_cert_issuer Property

The issuer of the certificate.

Syntax

def get_ssl_cert_issuer() -> str: ...

ssl_cert_issuer = property(get_ssl_cert_issuer, None)

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

ssl_cert_private_key Property

The private key of the certificate (if available).

Syntax

def get_ssl_cert_private_key() -> str: ...

ssl_cert_private_key = property(get_ssl_cert_private_key, None)

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The ssl_cert_private_key may be available but not exportable. In this case, ssl_cert_private_key returns an empty string.

This property is read-only.

ssl_cert_private_key_available Property

Whether a PrivateKey is available for the selected certificate.

Syntax

def get_ssl_cert_private_key_available() -> bool: ...

ssl_cert_private_key_available = property(get_ssl_cert_private_key_available, None)

Default Value

FALSE

Remarks

Whether a ssl_cert_private_key is available for the selected certificate. If ssl_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

ssl_cert_private_key_container Property

The name of the PrivateKey container for the certificate (if available).

Syntax

def get_ssl_cert_private_key_container() -> str: ...

ssl_cert_private_key_container = property(get_ssl_cert_private_key_container, None)

Default Value

""

Remarks

The name of the ssl_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

ssl_cert_public_key Property

The public key of the certificate.

Syntax

def get_ssl_cert_public_key() -> str: ...

ssl_cert_public_key = property(get_ssl_cert_public_key, None)

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

ssl_cert_public_key_algorithm Property

The textual description of the certificate's public key algorithm.

Syntax

def get_ssl_cert_public_key_algorithm() -> str: ...

ssl_cert_public_key_algorithm = property(get_ssl_cert_public_key_algorithm, None)

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

ssl_cert_public_key_length Property

The length of the certificate's public key (in bits).

Syntax

def get_ssl_cert_public_key_length() -> int: ...

ssl_cert_public_key_length = property(get_ssl_cert_public_key_length, None)

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

ssl_cert_serial_number Property

The serial number of the certificate encoded as a string.

Syntax

def get_ssl_cert_serial_number() -> str: ...

ssl_cert_serial_number = property(get_ssl_cert_serial_number, None)

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

ssl_cert_signature_algorithm Property

The text description of the certificate's signature algorithm.

Syntax

def get_ssl_cert_signature_algorithm() -> str: ...

ssl_cert_signature_algorithm = property(get_ssl_cert_signature_algorithm, None)

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

ssl_cert_store Property

The name of the certificate store for the client certificate.

Syntax

def get_ssl_cert_store() -> bytes: ...
def set_ssl_cert_store(value: bytes) -> None: ...

ssl_cert_store = property(get_ssl_cert_store, set_ssl_cert_store)

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The ssl_cert_store_type property denotes the type of the certificate store specified by ssl_cert_store. If the store is password-protected, specify the password in ssl_cert_store_password.

ssl_cert_store is used in conjunction with the ssl_cert_subject property to specify client certificates. If ssl_cert_store has a value, and ssl_cert_subject or ssl_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_cert_subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

ssl_cert_store_password Property

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

def get_ssl_cert_store_password() -> str: ...
def set_ssl_cert_store_password(value: str) -> None: ...

ssl_cert_store_password = property(get_ssl_cert_store_password, set_ssl_cert_store_password)

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

ssl_cert_store_type Property

The type of certificate store for this certificate.

Syntax

def get_ssl_cert_store_type() -> int: ...
def set_ssl_cert_store_type(value: int) -> None: ...

ssl_cert_store_type = property(get_ssl_cert_store_type, set_ssl_cert_store_type)

Default Value

0

Remarks

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

ssl_cert_subject_alt_names Property

Comma-separated lists of alternative subject names for the certificate.

Syntax

def get_ssl_cert_subject_alt_names() -> str: ...

ssl_cert_subject_alt_names = property(get_ssl_cert_subject_alt_names, None)

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

ssl_cert_thumbprint_md5 Property

The MD5 hash of the certificate.

Syntax

def get_ssl_cert_thumbprint_md5() -> str: ...

ssl_cert_thumbprint_md5 = property(get_ssl_cert_thumbprint_md5, None)

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_cert_thumbprint_sha1 Property

The SHA-1 hash of the certificate.

Syntax

def get_ssl_cert_thumbprint_sha1() -> str: ...

ssl_cert_thumbprint_sha1 = property(get_ssl_cert_thumbprint_sha1, None)

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_cert_thumbprint_sha256 Property

The SHA-256 hash of the certificate.

Syntax

def get_ssl_cert_thumbprint_sha256() -> str: ...

ssl_cert_thumbprint_sha256 = property(get_ssl_cert_thumbprint_sha256, None)

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_cert_usage Property

The text description of UsageFlags .

Syntax

def get_ssl_cert_usage() -> str: ...

ssl_cert_usage = property(get_ssl_cert_usage, None)

Default Value

""

Remarks

The text description of ssl_cert_usage_flags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

ssl_cert_usage_flags Property

The flags that show intended use for the certificate.

Syntax

def get_ssl_cert_usage_flags() -> int: ...

ssl_cert_usage_flags = property(get_ssl_cert_usage_flags, None)

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of ssl_cert_usage_flags is a combination of the following flags:

Please see the ssl_cert_usage property for a text representation of ssl_cert_usage_flags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

ssl_cert_version Property

The certificate's version number.

Syntax

def get_ssl_cert_version() -> str: ...

ssl_cert_version = property(get_ssl_cert_version, None)

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

ssl_cert_subject Property

The subject of the certificate used for client authentication.

Syntax

def get_ssl_cert_subject() -> str: ...
def set_ssl_cert_subject(value: str) -> None: ...

ssl_cert_subject = property(get_ssl_cert_subject, set_ssl_cert_subject)

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

ssl_cert_encoded Property

The certificate (PEM/Base64 encoded).

Syntax

def get_ssl_cert_encoded() -> bytes: ...
def set_ssl_cert_encoded(value: bytes) -> None: ...

ssl_cert_encoded = property(get_ssl_cert_encoded, set_ssl_cert_encoded)

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_cert_store and ssl_cert_subject properties also may be used to specify a certificate.

When ssl_cert_encoded is set, a search is initiated in the current ssl_cert_store for the private key of the certificate. If the key is found, ssl_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_cert_subject is set to an empty string.

ssl_provider Property

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Syntax

def get_ssl_provider() -> int: ...
def set_ssl_provider(value: int) -> None: ...

ssl_provider = property(get_ssl_provider, set_ssl_provider)

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic), the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are as follows:

In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.

When Automatic is selected, on Windows, the class will use the platform implementation. On Linux/macOS, the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used on all platforms.

ssl_server_cert_effective_date Property

The date on which this certificate becomes valid.

Syntax

def get_ssl_server_cert_effective_date() -> str: ...

ssl_server_cert_effective_date = property(get_ssl_server_cert_effective_date, None)

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

ssl_server_cert_expiration_date Property

The date on which the certificate expires.

Syntax

def get_ssl_server_cert_expiration_date() -> str: ...

ssl_server_cert_expiration_date = property(get_ssl_server_cert_expiration_date, None)

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

ssl_server_cert_extended_key_usage Property

A comma-delimited list of extended key usage identifiers.

Syntax

def get_ssl_server_cert_extended_key_usage() -> str: ...

ssl_server_cert_extended_key_usage = property(get_ssl_server_cert_extended_key_usage, None)

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

ssl_server_cert_fingerprint Property

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

def get_ssl_server_cert_fingerprint() -> str: ...

ssl_server_cert_fingerprint = property(get_ssl_server_cert_fingerprint, None)

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

ssl_server_cert_fingerprint_sha1 Property

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

def get_ssl_server_cert_fingerprint_sha1() -> str: ...

ssl_server_cert_fingerprint_sha1 = property(get_ssl_server_cert_fingerprint_sha1, None)

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

ssl_server_cert_fingerprint_sha256 Property

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

def get_ssl_server_cert_fingerprint_sha256() -> str: ...

ssl_server_cert_fingerprint_sha256 = property(get_ssl_server_cert_fingerprint_sha256, None)

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

ssl_server_cert_issuer Property

The issuer of the certificate.

Syntax

def get_ssl_server_cert_issuer() -> str: ...

ssl_server_cert_issuer = property(get_ssl_server_cert_issuer, None)

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

ssl_server_cert_private_key Property

The private key of the certificate (if available).

Syntax

def get_ssl_server_cert_private_key() -> str: ...

ssl_server_cert_private_key = property(get_ssl_server_cert_private_key, None)

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The ssl_server_cert_private_key may be available but not exportable. In this case, ssl_server_cert_private_key returns an empty string.

This property is read-only.

ssl_server_cert_private_key_available Property

Whether a PrivateKey is available for the selected certificate.

Syntax

def get_ssl_server_cert_private_key_available() -> bool: ...

ssl_server_cert_private_key_available = property(get_ssl_server_cert_private_key_available, None)

Default Value

FALSE

Remarks

Whether a ssl_server_cert_private_key is available for the selected certificate. If ssl_server_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

ssl_server_cert_private_key_container Property

The name of the PrivateKey container for the certificate (if available).

Syntax

def get_ssl_server_cert_private_key_container() -> str: ...

ssl_server_cert_private_key_container = property(get_ssl_server_cert_private_key_container, None)

Default Value

""

Remarks

The name of the ssl_server_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

ssl_server_cert_public_key Property

The public key of the certificate.

Syntax

def get_ssl_server_cert_public_key() -> str: ...

ssl_server_cert_public_key = property(get_ssl_server_cert_public_key, None)

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

ssl_server_cert_public_key_algorithm Property

The textual description of the certificate's public key algorithm.

Syntax

def get_ssl_server_cert_public_key_algorithm() -> str: ...

ssl_server_cert_public_key_algorithm = property(get_ssl_server_cert_public_key_algorithm, None)

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

ssl_server_cert_public_key_length Property

The length of the certificate's public key (in bits).

Syntax

def get_ssl_server_cert_public_key_length() -> int: ...

ssl_server_cert_public_key_length = property(get_ssl_server_cert_public_key_length, None)

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

ssl_server_cert_serial_number Property

The serial number of the certificate encoded as a string.

Syntax

def get_ssl_server_cert_serial_number() -> str: ...

ssl_server_cert_serial_number = property(get_ssl_server_cert_serial_number, None)

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

ssl_server_cert_signature_algorithm Property

The text description of the certificate's signature algorithm.

Syntax

def get_ssl_server_cert_signature_algorithm() -> str: ...

ssl_server_cert_signature_algorithm = property(get_ssl_server_cert_signature_algorithm, None)

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

ssl_server_cert_store Property

The name of the certificate store for the client certificate.

Syntax

def get_ssl_server_cert_store() -> bytes: ...

ssl_server_cert_store = property(get_ssl_server_cert_store, None)

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The ssl_server_cert_store_type property denotes the type of the certificate store specified by ssl_server_cert_store. If the store is password-protected, specify the password in ssl_server_cert_store_password.

ssl_server_cert_store is used in conjunction with the ssl_server_cert_subject property to specify client certificates. If ssl_server_cert_store has a value, and ssl_server_cert_subject or ssl_server_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_server_cert_subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

This property is read-only.

ssl_server_cert_store_password Property

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

def get_ssl_server_cert_store_password() -> str: ...

ssl_server_cert_store_password = property(get_ssl_server_cert_store_password, None)

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

This property is read-only.

ssl_server_cert_store_type Property

The type of certificate store for this certificate.

Syntax

def get_ssl_server_cert_store_type() -> int: ...

ssl_server_cert_store_type = property(get_ssl_server_cert_store_type, None)

Default Value

0

Remarks

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

This property is read-only.

ssl_server_cert_subject_alt_names Property

Comma-separated lists of alternative subject names for the certificate.

Syntax

def get_ssl_server_cert_subject_alt_names() -> str: ...

ssl_server_cert_subject_alt_names = property(get_ssl_server_cert_subject_alt_names, None)

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

ssl_server_cert_thumbprint_md5 Property

The MD5 hash of the certificate.

Syntax

def get_ssl_server_cert_thumbprint_md5() -> str: ...

ssl_server_cert_thumbprint_md5 = property(get_ssl_server_cert_thumbprint_md5, None)

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_server_cert_thumbprint_sha1 Property

The SHA-1 hash of the certificate.

Syntax

def get_ssl_server_cert_thumbprint_sha1() -> str: ...

ssl_server_cert_thumbprint_sha1 = property(get_ssl_server_cert_thumbprint_sha1, None)

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_server_cert_thumbprint_sha256 Property

The SHA-256 hash of the certificate.

Syntax

def get_ssl_server_cert_thumbprint_sha256() -> str: ...

ssl_server_cert_thumbprint_sha256 = property(get_ssl_server_cert_thumbprint_sha256, None)

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_server_cert_usage Property

The text description of UsageFlags .

Syntax

def get_ssl_server_cert_usage() -> str: ...

ssl_server_cert_usage = property(get_ssl_server_cert_usage, None)

Default Value

""

Remarks

The text description of ssl_server_cert_usage_flags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

ssl_server_cert_usage_flags Property

The flags that show intended use for the certificate.

Syntax

def get_ssl_server_cert_usage_flags() -> int: ...

ssl_server_cert_usage_flags = property(get_ssl_server_cert_usage_flags, None)

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of ssl_server_cert_usage_flags is a combination of the following flags:

Please see the ssl_server_cert_usage property for a text representation of ssl_server_cert_usage_flags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

ssl_server_cert_version Property

The certificate's version number.

Syntax

def get_ssl_server_cert_version() -> str: ...

ssl_server_cert_version = property(get_ssl_server_cert_version, None)

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

ssl_server_cert_subject Property

The subject of the certificate used for client authentication.

Syntax

def get_ssl_server_cert_subject() -> str: ...

ssl_server_cert_subject = property(get_ssl_server_cert_subject, None)

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

This property is read-only.

ssl_server_cert_encoded Property

The certificate (PEM/Base64 encoded).

Syntax

def get_ssl_server_cert_encoded() -> bytes: ...

ssl_server_cert_encoded = property(get_ssl_server_cert_encoded, None)

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_server_cert_store and ssl_server_cert_subject properties also may be used to specify a certificate.

When ssl_server_cert_encoded is set, a search is initiated in the current ssl_server_cert_store for the private key of the certificate. If the key is found, ssl_server_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_server_cert_subject is set to an empty string.

This property is read-only.

start_date Property

Specifies the date and time that an event begins.

Syntax

def get_start_date() -> str: ...
def set_start_date(value: str) -> None: ...

start_date = property(get_start_date, set_start_date)

Default Value

""

Remarks

This property specifies the date and time that an event begins. The date/time format is "YYYYMMDDThhmmss", where "T" indicates the break between date and time. You may also append a 1-character alpha code for the timezone. For instance, "20100104T123456Z" indicates January 4th, 2010 at 12:34:56 PM UTC.

This property is filled from the response to a get_event, and is also used when creating an event to be added using the create_event method. However, when requesting a report using the get_calendar_report method, the contents of this property will only be valid inside the on_event_details event.

status Property

Defines the overall status or confirmation for the calendar event.

Syntax

def get_status() -> str: ...
def set_status(value: str) -> None: ...

status = property(get_status, set_status)

Default Value

""

Remarks

In a group-scheduled calendar component, the property is used by the organizer to provide a confirmation of the event to the attendees. For example in a vEvent event_type the organizer can indicate that a meeting is tentative, confirmed, or canceled. For a vTodo event_type, the organizer can indicate that an action item needs action, is completed, is in process or being worked on, or has been canceled. In a vJournal event_type, the organizer can indicate that a journal entry is draft, final, or has been canceled or removed.

Statuses for a vEvent event_type:

This property is filled from the response to a get_event, and is also used when creating an event to be added using the create_event method. However, when requesting a report using the get_calendar_report method, the contents of this property will only be valid inside the on_event_details event.

summary Property

Defines a short summary or subject for the calendar event.

Syntax

def get_summary() -> str: ...
def set_summary(value: str) -> None: ...

summary = property(get_summary, set_summary)

Default Value

""

Remarks

This property defines a short summary or subject for the calendar event.

This property is filled from the response to a get_event, and is also used when creating an event to be added using the create_event method. However, when requesting a report using the get_calendar_report method, the contents of this property will only be valid inside the on_event_details event.

timeout Property

The timeout for the class.

Syntax

def get_timeout() -> int: ...
def set_timeout(value: int) -> None: ...

timeout = property(get_timeout, set_timeout)

Default Value

60

Remarks

If the timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If timeout is set to a positive value, the class will wait for the operation to complete before returning control.

The class will use do_events to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.

If timeout expires, and the operation is not yet complete, the class fails with an error.

Note: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by timeout seconds when any amount of data is successfully sent or received.

The default value for the timeout property is 60 seconds.

timestamp Property

Specifies the date and time that the instance of the event was created.

Syntax

def get_timestamp() -> str: ...
def set_timestamp(value: str) -> None: ...

timestamp = property(get_timestamp, set_timestamp)

Default Value

""

Remarks

This property specifies the date and time that the instance of the event was created. The date/time format is "YYYYMMDDThhmmss", where "T" indicates the break between date and time. You may also append a 1-character alpha code for the timezone. For instance, "20100104T123456Z" indicates January 4th, 2010 at 12:34:56 PM UTC.

Note: This property must be specified in UTC time format.

This property is filled from the response to a get_event, and is also used when creating an event to be added using the create_event method. However, when requesting a report using the get_calendar_report method, the contents of this property will only be valid inside the on_event_details event.

timezone_dst_name Property

The customary name for the daylight-savings time zone.

Syntax

def get_timezone_dst_name() -> str: ...
def set_timezone_dst_name(value: str) -> None: ...

timezone_dst_name = property(get_timezone_dst_name, set_timezone_dst_name)

Default Value

""

Remarks

The customary name for the daylight-savings time zone. This could be used for displaying dates, and there is no restriction to the format. For instance, Eastern Daylight Time may be represented as "EDT", "Eastern Daylight Time (US & Canada)", or any other arbitrary representation.

The following example shows the CalTimezone set to Eastern time. CalDAV.Timezone.TimezoneId = "US-Eastern"; CalDAV.Timezone.URL = "http://zones.example.com/tz/America-New_York.ics" CalDAV.Timezone.StdName = "Eastern Standard Time (US & Canada)"; CalDAV.Timezone.StdStart = "20071104T020000"; CalDAV.Timezone.StdOffsetFrom = "-400"; CalDAV.Timezone.StdOffsetTo = "-500"; CalDAV.Timezone.StdRule = "FREQ=YEARLY;BYDAY=1SU;BYMONTH=11"; CalDAV.TimeZone.DSTName = "Eastern Daylight Time (US & Canada)"; CalDAV.TimeZone.DSTStart = "20070311T020000"; CalDAV.TimeZone.DSTOffsetFrom = "-500"; CalDAV.TimeZone.DSTOffsetTo = "-400"; CalDAV.TimeZone.DSTRule = "FREQ=YEARLY;BYDAY=2SU;BYMONTH=3";

timezone_dst_offset_from Property

The UTC offset that is in use when the onset of this time zone observance begins.

Syntax

def get_timezone_dst_offset_from() -> str: ...
def set_timezone_dst_offset_from(value: str) -> None: ...

timezone_dst_offset_from = property(get_timezone_dst_offset_from, set_timezone_dst_offset_from)

Default Value

""

Remarks

The UTC offset that is in use when the onset of this time zone observance begins. timezone_dst_offset_from is combined with timezone_dst_start to define the effective onset for the daylight-time time zone definition.

timezone_dst_start, timezone_dst_offset_from, and timezone_dst_offset_to are all required to specify the daylight-savings time zone.

The following example shows the CalTimezone set to Eastern time. CalDAV.Timezone.TimezoneId = "US-Eastern"; CalDAV.Timezone.URL = "http://zones.example.com/tz/America-New_York.ics" CalDAV.Timezone.StdName = "Eastern Standard Time (US & Canada)"; CalDAV.Timezone.StdStart = "20071104T020000"; CalDAV.Timezone.StdOffsetFrom = "-400"; CalDAV.Timezone.StdOffsetTo = "-500"; CalDAV.Timezone.StdRule = "FREQ=YEARLY;BYDAY=1SU;BYMONTH=11"; CalDAV.TimeZone.DSTName = "Eastern Daylight Time (US & Canada)"; CalDAV.TimeZone.DSTStart = "20070311T020000"; CalDAV.TimeZone.DSTOffsetFrom = "-500"; CalDAV.TimeZone.DSTOffsetTo = "-400"; CalDAV.TimeZone.DSTRule = "FREQ=YEARLY;BYDAY=2SU;BYMONTH=3";

timezone_dst_offset_to Property

The UTC offset for daylight savings time, when this observance is in use.

Syntax

def get_timezone_dst_offset_to() -> str: ...
def set_timezone_dst_offset_to(value: str) -> None: ...

timezone_dst_offset_to = property(get_timezone_dst_offset_to, set_timezone_dst_offset_to)

Default Value

""

Remarks

The UTC offset for daylight savings time, when this observance is in use.

timezone_dst_start, timezone_dst_offset_from, and timezone_dst_offset_to are all required to specify the daylight-savings time zone.

The following example shows the CalTimezone set to Eastern time. CalDAV.Timezone.TimezoneId = "US-Eastern"; CalDAV.Timezone.URL = "http://zones.example.com/tz/America-New_York.ics" CalDAV.Timezone.StdName = "Eastern Standard Time (US & Canada)"; CalDAV.Timezone.StdStart = "20071104T020000"; CalDAV.Timezone.StdOffsetFrom = "-400"; CalDAV.Timezone.StdOffsetTo = "-500"; CalDAV.Timezone.StdRule = "FREQ=YEARLY;BYDAY=1SU;BYMONTH=11"; CalDAV.TimeZone.DSTName = "Eastern Daylight Time (US & Canada)"; CalDAV.TimeZone.DSTStart = "20070311T020000"; CalDAV.TimeZone.DSTOffsetFrom = "-500"; CalDAV.TimeZone.DSTOffsetTo = "-400"; CalDAV.TimeZone.DSTRule = "FREQ=YEARLY;BYDAY=2SU;BYMONTH=3";

timezone_dst_rule Property

This property defines the recurrence rule for the onset of this daylight savings time observance.

Syntax

def get_timezone_dst_rule() -> str: ...
def set_timezone_dst_rule(value: str) -> None: ...

timezone_dst_rule = property(get_timezone_dst_rule, set_timezone_dst_rule)

Default Value

""

Remarks

This property defines the recurrence rule for the onset of this daylight savings time observance. Some specific requirements for the usage of timezone_dst_rule for this purpose include:

For instance, in the USA Eastern Daylight time before 2007 started on the first Sunday of April. In 2007 Daylight time was changed to begin on the 2nd Sunday in March. Therefore, the UNTIL option should indicate the LAST time this rule will be observed. (2am on April 2nd, 2006). Such a time zone declaration would look like this: CalDAV.time zone.DSTName = "EDT" CalDAV.time zone.DSTStart = "19870405T020000" CalDAV.time zone.DSTOffsetFrom = "-500" CalDAV.time zone.DSTOffsetTo = "-400" CalDAV.time zone.DSTRule = "FREQ=YEARLY;BYMONTH=4;BYDAY=1SU;UNTIL=20060402T070000Z"

timezone_dst_start Property

The effective onset date and local time for the daylight-time time zone definition.

Syntax

def get_timezone_dst_start() -> str: ...
def set_timezone_dst_start(value: str) -> None: ...

timezone_dst_start = property(get_timezone_dst_start, set_timezone_dst_start)

Default Value

""

Remarks

The effective onset date and local time for the daylight-time time zone definition. The date and time MUST be specified as a date with a local time value in the format "YYYYMMDDThhmmss", where "T" indicates the break between date and time.

timezone_dst_start, timezone_dst_offset_from, and timezone_dst_offset_to are all required to specify the daylight-savings time zone.

The following example shows the CalTimezone set to Eastern time. CalDAV.Timezone.TimezoneId = "US-Eastern"; CalDAV.Timezone.URL = "http://zones.example.com/tz/America-New_York.ics" CalDAV.Timezone.StdName = "Eastern Standard Time (US & Canada)"; CalDAV.Timezone.StdStart = "20071104T020000"; CalDAV.Timezone.StdOffsetFrom = "-400"; CalDAV.Timezone.StdOffsetTo = "-500"; CalDAV.Timezone.StdRule = "FREQ=YEARLY;BYDAY=1SU;BYMONTH=11"; CalDAV.TimeZone.DSTName = "Eastern Daylight Time (US & Canada)"; CalDAV.TimeZone.DSTStart = "20070311T020000"; CalDAV.TimeZone.DSTOffsetFrom = "-500"; CalDAV.TimeZone.DSTOffsetTo = "-400"; CalDAV.TimeZone.DSTRule = "FREQ=YEARLY;BYDAY=2SU;BYMONTH=3";

timezone_last_modified Property

This optional property is a UTC value that specifies the date and time that this time zone definition was last updated.

Syntax

def get_timezone_last_modified() -> str: ...
def set_timezone_last_modified(value: str) -> None: ...

timezone_last_modified = property(get_timezone_last_modified, set_timezone_last_modified)

Default Value

""

Remarks

This optional property is a UTC value that specifies the date and time that this time zone definition was last updated.

timezone_std_name Property

The customary name for the standard time zone.

Syntax

def get_timezone_std_name() -> str: ...
def set_timezone_std_name(value: str) -> None: ...

timezone_std_name = property(get_timezone_std_name, set_timezone_std_name)

Default Value

""

Remarks

The customary name for the standard time zone. This could be used for displaying dates, and there is no restriction to the format. For instance, Eastern Standard Time may be represented as "EST", "Eastern Standard Time (US & Canada)", or any other arbitrary representation.

The following example shows the CalTimezone set to Eastern time. CalDAV.Timezone.TimezoneId = "US-Eastern"; CalDAV.Timezone.URL = "http://zones.example.com/tz/America-New_York.ics" CalDAV.Timezone.StdName = "Eastern Standard Time (US & Canada)"; CalDAV.Timezone.StdStart = "20071104T020000"; CalDAV.Timezone.StdOffsetFrom = "-400"; CalDAV.Timezone.StdOffsetTo = "-500"; CalDAV.Timezone.StdRule = "FREQ=YEARLY;BYDAY=1SU;BYMONTH=11"; CalDAV.TimeZone.DSTName = "Eastern Daylight Time (US & Canada)"; CalDAV.TimeZone.DSTStart = "20070311T020000"; CalDAV.TimeZone.DSTOffsetFrom = "-500"; CalDAV.TimeZone.DSTOffsetTo = "-400"; CalDAV.TimeZone.DSTRule = "FREQ=YEARLY;BYDAY=2SU;BYMONTH=3";

timezone_std_offset_from Property

The UTC offset that is in use when the onset of this time zone observance begins.

Syntax

def get_timezone_std_offset_from() -> str: ...
def set_timezone_std_offset_from(value: str) -> None: ...

timezone_std_offset_from = property(get_timezone_std_offset_from, set_timezone_std_offset_from)

Default Value

""

Remarks

The UTC offset that is in use when the onset of this time zone observance begins. timezone_std_offset_from is combined with timezone_std_start to define the effective onset for the standard-time time zone definition.

timezone_std_start, timezone_std_offset_from, and timezone_std_offset_to are all required to specify the standard-time time zone.

The following example shows the CalTimezone set to Eastern time. CalDAV.Timezone.TimezoneId = "US-Eastern"; CalDAV.Timezone.URL = "http://zones.example.com/tz/America-New_York.ics" CalDAV.Timezone.StdName = "Eastern Standard Time (US & Canada)"; CalDAV.Timezone.StdStart = "20071104T020000"; CalDAV.Timezone.StdOffsetFrom = "-400"; CalDAV.Timezone.StdOffsetTo = "-500"; CalDAV.Timezone.StdRule = "FREQ=YEARLY;BYDAY=1SU;BYMONTH=11"; CalDAV.TimeZone.DSTName = "Eastern Daylight Time (US & Canada)"; CalDAV.TimeZone.DSTStart = "20070311T020000"; CalDAV.TimeZone.DSTOffsetFrom = "-500"; CalDAV.TimeZone.DSTOffsetTo = "-400"; CalDAV.TimeZone.DSTRule = "FREQ=YEARLY;BYDAY=2SU;BYMONTH=3";

timezone_std_offset_to Property

The UTC offset for standard time, when this observance is in use.

Syntax

def get_timezone_std_offset_to() -> str: ...
def set_timezone_std_offset_to(value: str) -> None: ...

timezone_std_offset_to = property(get_timezone_std_offset_to, set_timezone_std_offset_to)

Default Value

""

Remarks

The UTC offset for standard time, when this observance is in use.

timezone_std_start, timezone_std_offset_from, and timezone_std_offset_to are all required to specify the standard-time time zone.

The following example shows the CalTimezone set to Eastern time. CalDAV.Timezone.TimezoneId = "US-Eastern"; CalDAV.Timezone.URL = "http://zones.example.com/tz/America-New_York.ics" CalDAV.Timezone.StdName = "Eastern Standard Time (US & Canada)"; CalDAV.Timezone.StdStart = "20071104T020000"; CalDAV.Timezone.StdOffsetFrom = "-400"; CalDAV.Timezone.StdOffsetTo = "-500"; CalDAV.Timezone.StdRule = "FREQ=YEARLY;BYDAY=1SU;BYMONTH=11"; CalDAV.TimeZone.DSTName = "Eastern Daylight Time (US & Canada)"; CalDAV.TimeZone.DSTStart = "20070311T020000"; CalDAV.TimeZone.DSTOffsetFrom = "-500"; CalDAV.TimeZone.DSTOffsetTo = "-400"; CalDAV.TimeZone.DSTRule = "FREQ=YEARLY;BYDAY=2SU;BYMONTH=3";

timezone_std_rule Property

This property defines the recurrence rule for the onset of this standard time observance.

Syntax

def get_timezone_std_rule() -> str: ...
def set_timezone_std_rule(value: str) -> None: ...

timezone_std_rule = property(get_timezone_std_rule, set_timezone_std_rule)

Default Value

""

Remarks

This property defines the recurrence rule for the onset of this standard time observance. Some specific requirements for the usage of timezone_dst_rule for this purpose include:

For instance, in the USA Eastern Standard time before 2007 started on the last Sunday of October. In 2007 Standard time was changed to begin on the 1st Sunday in November. Therefore, the UNTIL option should indicate the LAST time this rule will be observed. (2am on October 29th, 2006). Such a time zone declaration would look like this: CalDAV.time zone.StdName = "EST" CalDAV.time zone.StdStart = "19671029T020000" CalDAV.time zone.StdOffsetFrom = "-400" CalDAV.time zone.StdOffsetTo = "-500" CalDAV.time zone.StdRule = "FREQ=YEARLY;BYMONTH=10;BYDAY=-1SU;UNTIL=20061029T060000Z"

timezone_std_start Property

The effective onset date and local time for the standard-time time zone definition.

Syntax

def get_timezone_std_start() -> str: ...
def set_timezone_std_start(value: str) -> None: ...

timezone_std_start = property(get_timezone_std_start, set_timezone_std_start)

Default Value

""

Remarks

The effective onset date and local time for the standard-time time zone definition. The date and time MUST be specified as a date with a local time value. in the format "YYYYMMDDThhmmss", where "T" indicates the break between date and time.

timezone_std_start, timezone_std_offset_from, and timezone_std_offset_to are all required to specify the standard-time time zone.

The following example shows the CalTimezone set to Eastern time. CalDAV.Timezone.TimezoneId = "US-Eastern"; CalDAV.Timezone.URL = "http://zones.example.com/tz/America-New_York.ics" CalDAV.Timezone.StdName = "Eastern Standard Time (US & Canada)"; CalDAV.Timezone.StdStart = "20071104T020000"; CalDAV.Timezone.StdOffsetFrom = "-400"; CalDAV.Timezone.StdOffsetTo = "-500"; CalDAV.Timezone.StdRule = "FREQ=YEARLY;BYDAY=1SU;BYMONTH=11"; CalDAV.TimeZone.DSTName = "Eastern Daylight Time (US & Canada)"; CalDAV.TimeZone.DSTStart = "20070311T020000"; CalDAV.TimeZone.DSTOffsetFrom = "-500"; CalDAV.TimeZone.DSTOffsetTo = "-400"; CalDAV.TimeZone.DSTRule = "FREQ=YEARLY;BYDAY=2SU;BYMONTH=3";

timezone_id Property

This property specifies a text value that uniquely identifies this CalTimezone calendar class.

Syntax

def get_timezone_id() -> str: ...
def set_timezone_id(value: str) -> None: ...

timezone_id = property(get_timezone_id, set_timezone_id)

Default Value

""

Remarks

This property specifies a text value that uniquely identifies this CalTimezone calendar component.

Note: This document does not define a naming convention for time zone identifiers. Implementers may want to use the naming conventions defined in existing time zone specifications such as the public-domain TZ database [TZDB].

This property is required. If it is not present, no time zone information will be generated inside the MakeCalendar request.

timezone_url Property

Optionally points to a published time zone definition.

Syntax

def get_timezone_url() -> str: ...
def set_timezone_url(value: str) -> None: ...

timezone_url = property(get_timezone_url, set_timezone_url)

Default Value

""

Remarks

Optionally points to a published time zone definition. If set, this property should refer to a resource that is accessible by anyone who might need to interpret the object. This should not normally be a "file" URL or other URL that is not widely accessible.

transparency Property

Defines whether or not an event is transparent to busy time searches.

Syntax

def get_transparency() -> str: ...
def set_transparency(value: str) -> None: ...

transparency = property(get_transparency, set_transparency)

Default Value

""

Remarks

This property defines whether or not an event is transparent to busy time searches. Time Transparency is the characteristic of an event that determines whether it appears to consume time on a calendar. Events that consume actual time for the individual or resource associated with the calendar SHOULD be recorded as "OPAQUE", allowing them to be detected by free/busy time searches. Other events, which do not take up the individual's (or resource's) time SHOULD be recorded as "TRANSPARENT", making them invisible to free/ busy time searches.

Custom transparency values may or may not be supported by your calendar implementation, but all implementations will support the "OPAQUE" and "TRANSPARENT" values.

This property is filled from the response to a get_event, and is also used when creating an event to be added using the create_event method. However, when requesting a report using the get_calendar_report method, the contents of this property will only be valid inside the on_event_details event.

uid Property

A persistent, globally unique identifier for the calendar event.

Syntax

def get_uid() -> str: ...
def set_uid(value: str) -> None: ...

uid = property(get_uid, set_uid)

Default Value

""

Remarks

This property contains a persistent, globally unique identifier. The generator of the identifier MUST guarantee that the identifier is unique. There are several algorithms that can be used to accomplish this. A good method to assure uniqueness is to put the domain name or a domain literal IP address of the host on which the identifier was created on the right-hand side of an "@", and on the left-hand side, put a combination of the current calendar date and time of day (i.e., formatted in as a date/time value) along with some other currently unique (perhaps sequential) identifier available on the system (for example, a process id number). Using a date/time value on the left-hand side and a domain name or domain literal on the right-hand side makes it possible to guarantee uniqueness since no two hosts should be using the same domain name or IP address at the same time. Though other algorithms will work, it is recommended that the right-hand side contain some domain identifier (either of the host itself or otherwise) such that the generator of the message identifier can guarantee the uniqueness of the left-hand side within the scope of that domain.

NOTE: Some CalDAV servers (Yahoo for example) require that the UID and the filename portion of the Resource URI match. For example, if the UID is "hello_world" then the ResourceURI parameter of the create_event should be "https://caldav.calendar.yahoo.com/dav/user_name/Calendar/My_Calendar/hello_world.ics". If the UID and filename portion of the URI do not match, the Yahoo CalDAV server will return a "302 Found" response indicating that the requested resource resides under a different URI. (Meaning the event was not added to the calendar)

This property is filled from the response to a get_event, and is also used when creating an event to be added using the create_event method. However, when requesting a report using the get_calendar_report method, the contents of this property will only be valid inside the on_event_details event.

url Property

Location of the event resource on the CalDAV server.

Syntax

def get_url() -> str: ...

url = property(get_url, None)

Default Value

""

Remarks

This property is read-only, and will be filled with the location of the event resource for each event returned. This will only be returned in response to a get_calendar_report transaction.

This property is filled from the response to a get_event, and is also used when creating an event to be added using the create_event method. However, when requesting a report using the get_calendar_report method, the contents of this property will only be valid inside the on_event_details event.

This property is read-only.

user Property

This property includes a user name if authentication is to be used.

Syntax

def get_user() -> str: ...
def set_user(value: str) -> None: ...

user = property(get_user, set_user)

Default Value

""

Remarks

This property contains a user name if authentication is to be used. If auth_scheme is set to HTTP Basic Authentication, The user and password are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".

If auth_scheme is set to HTTP Digest Authentication, the user and password properties are used to respond to the HTTP Digest Authentication challenge from the server.

If auth_scheme is set to NTLM, NTLM authentication will be attempted. If auth_scheme is set to NTLM, and user and password are empty, the class will attempt to authenticate using the current user's credentials.

add_cookie Method

Adds a cookie and the corresponding value to the outgoing request headers.

Syntax

def add_cookie(cookie_name: str, cookie_value: str) -> None: ...

Remarks

This method adds a cookie and the corresponding value to the outgoing request headers. Please refer to the cookies property for more information on cookies and how they are managed.

add_custom_property Method

Adds a form variable and the corresponding value.

Syntax

def add_custom_property(var_name: str, var_value: str) -> None: ...

Remarks

This property adds a form variable and the corresponding value. For information on form variables and how they are managed, please refer to the custom_properties properties.

Example using the add_custom_property method:

CalDAV.Reset() CalDAV.AddCustomProperty("propname1", "propvalue1") CalDAV.AddCustomProperty("propname2", "propvalue2") Example using Custom Property arrays: CalDAV.Reset() CalDAV.CustomPropertyCount = 2 CalDAV.CustomPropertyName (0) = "propname1" CalDAV.CustomPropertyValue(0) = "propvalue1" CalDAV.CustomPropertyName (1) = "propname2" CalDAV.CustomPropertyValue(1) = "propvalue2"

config Method

Sets or retrieves a configuration setting.

Syntax

def config(configuration_string: str) -> str: ...

Remarks

config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

copy_event Method

Copy events to a new location.

Syntax

def copy_event(source_resource_uri: str, destination_resource_uri: str) -> None: ...

Remarks

The copy_event method will copy the resource indicated by SourceResourceURI to a new location under the resource indicated by DestinationResourceURI.

This method is associated with the Depth property. If Depth is set to "0", the class will copy only SourceResourceURI. If Depth is set to "infinity", the class will copy SourceResourceURI and its entire subtree to the relative locations.

If the user has acquired a lock_calendar of infinite depth on either DestinationResourceURI or any collection it is under, SourceResourceURI will be added to that lock.

Note that neither Yahoo nor Google CalDAV servers support locking, copying, or moving calendar resources.

There is no standard format for resource URIs. Google for instance, uses "https://apidata.googleusercontent.com/caldav/v2/" plus your email address to access the default calendar. So "https://apidata.googleusercontent.com/caldav/v2/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://apidata.googleusercontent.com/caldav/v2/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://apidata.googleusercontent.com/caldav/v2/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 create_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_event. For example: CalDAV.UID = "1234567890"; CalDAV.CreateEvent("https://apidata.googleusercontent.com/caldav/v2/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: CalDAV.User = "username"; CalDAV.Password = "password"; CalDAV.CreateCalendar("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/", "My Hockey Calendar", "My 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.CreateEvent("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/qwerty1234567.ics"); CalDAV.GetCalendarReport("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/");

create_calendar Method

Creates a new calendar collection resource.

Syntax

def create_calendar(resource_uri: str, display_name: str, description: str) -> None: ...

Remarks

The create_calendar method creates a new calendar collection resource. A server MAY restrict calendar collection creation to particular collections.

Creating calendar collections is not supported by all CalDAV servers. Some calendar stores only support one calendar per user (or principal), and those are typically pre-created for each account.

The DisplayName and Description parameters should be set to a human readable display name and description of the calendar. The timezone property specifies the default timezone of the calendar.

To successfully create a calendar, the ResourceURI cannot already exist, and must point to a valid location where a new calendar can be created. The DAV:bind privilege MUST be granted to the current user on the parent collection of the specified ResourceURI.

The following example shows how to create a simple new calendar collection resource with Yahoo Calendar. calDAV.CreateCalendar("https://caldav.calendar.yahoo.com/dav/userid/Calendar/TestCal1", "My Display Name", "My Calendar Description);

Note that Google does not support creating a new calendar through CalDAV. It must be created through the Google calendar web interface.

There is no standard format for resource URIs. Google for instance, uses "https://apidata.googleusercontent.com/caldav/v2/" plus your email address to access the default calendar. So "https://apidata.googleusercontent.com/caldav/v2/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://apidata.googleusercontent.com/caldav/v2/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://apidata.googleusercontent.com/caldav/v2/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 create_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_event. For example: CalDAV.UID = "1234567890"; CalDAV.CreateEvent("https://apidata.googleusercontent.com/caldav/v2/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: CalDAV.User = "username"; CalDAV.Password = "password"; CalDAV.CreateCalendar("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/", "My Hockey Calendar", "My 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.CreateEvent("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/qwerty1234567.ics"); CalDAV.GetCalendarReport("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/");

create_event Method

Adds a calendar resource at the specified ResourceURI using the CalDAV PUT method.

Syntax

def create_event(resource_uri: str) -> None: ...

Remarks

This method adds a new event to the calendar collection at the specified ResourceURI. The ResourceURI must be a fully qualified URL to the location on the CalDAV server to which this event will be saved. If the ResourceURI already exists, the event at that URI will be overwritten.

NOTE: Some CalDAV servers (Yahoo for example) require that the UID and the filename portion of the URI match. For example, if the UID is "hello_world" then the ResourceURI parameter of the create_event should be "https://caldav.calendar.yahoo.com/dav/user_name/Calendar/My_Calendar/hello_world.ics". If the UID and filename portion of the URI do not match, the Yahoo CalDAV server will return a "302 Found" response indicating that the requested resource resides under a different URI. (Meaning the event was not added to the calendar)

The following properties are used when creating a request with create_event or export_ics, and will be filled after calling get_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.

• alarms
• attendees
• categories
• classification
• completed
• Created
• custom_properties
• Depth
• description
• duration
• end_date
• event_type
• last_modified
• location
• organizer
• priority
• recurrence
• sequence
• start_date
• status
• summary
• timestamp
• timezone
• transparency
• uid
• url

There is no standard format for resource URIs. Google for instance, uses "https://apidata.googleusercontent.com/caldav/v2/" plus your email address to access the default calendar. So "https://apidata.googleusercontent.com/caldav/v2/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://apidata.googleusercontent.com/caldav/v2/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://apidata.googleusercontent.com/caldav/v2/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 create_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_event. For example: CalDAV.UID = "1234567890"; CalDAV.CreateEvent("https://apidata.googleusercontent.com/caldav/v2/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: CalDAV.User = "username"; CalDAV.Password = "password"; CalDAV.CreateCalendar("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/", "My Hockey Calendar", "My 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.CreateEvent("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/qwerty1234567.ics"); CalDAV.GetCalendarReport("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/");

delete_calendar Method

Deletes a calendar collection resource.

Syntax

def delete_calendar(resource_uri: str) -> None: ...

Remarks

This method deletes a calendar collection resource specified by ResourceURI. To successfully delete a calendar, the ResourceURI should already exist, and must point to a valid location where a calendar can be deleted. The DAV:bind privilege MUST be granted to the current user on the parent collection of the specified ResourceURI.

The following example shows how to delete a calendar collection resource: calDAV.DeleteCalendar("https://caldav.calendar.yahoo.com/dav/userid/Calendar/TestCal1"); In a NextCloud server, if all calendars are deleted, a new Personal calendar is automatically created.

Note that Google does not support deleting a calendar through CalDAV. It must be created through the Google calendar web interface.

There is no standard format for resource URIs. Google for instance, uses "https://apidata.googleusercontent.com/caldav/v2/" plus your email address to access the default calendar. So "https://apidata.googleusercontent.com/caldav/v2/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://apidata.googleusercontent.com/caldav/v2/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://apidata.googleusercontent.com/caldav/v2/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 create_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_event. For example: CalDAV.UID = "1234567890"; CalDAV.CreateEvent("https://apidata.googleusercontent.com/caldav/v2/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: CalDAV.User = "username"; CalDAV.Password = "password"; CalDAV.CreateCalendar("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/", "My Hockey Calendar", "My 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.CreateEvent("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/qwerty1234567.ics"); CalDAV.GetCalendarReport("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/");

delete_event Method

Delete a resource or collection.

Syntax

def delete_event(resource_uri: str) -> None: ...

Remarks

This method behaves independently of the Depth property. It is used to delete the resource or collection specified by ResourceURI. If ResourceURI denotes a non-collection resource, it is first removed from any collection in which it is contained, it is then removed from the server. If ResourceURI denotes a collection, the server behaves as if the command were issued with an infinite depth (i.e., all internal member URIs denoting single resources or collections are deleted).

There is no standard format for resource URIs. Google for instance, uses "https://apidata.googleusercontent.com/caldav/v2/" plus your email address to access the default calendar. So "https://apidata.googleusercontent.com/caldav/v2/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://apidata.googleusercontent.com/caldav/v2/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://apidata.googleusercontent.com/caldav/v2/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 create_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_event. For example: CalDAV.UID = "1234567890"; CalDAV.CreateEvent("https://apidata.googleusercontent.com/caldav/v2/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: CalDAV.User = "username"; CalDAV.Password = "password"; CalDAV.CreateCalendar("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/", "My Hockey Calendar", "My 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.CreateEvent("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/qwerty1234567.ics"); CalDAV.GetCalendarReport("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/");

do_events Method

This method processes events from the internal message queue.

Syntax

def do_events() -> None: ...

Remarks

When do_events is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.

export_ics Method

Generates an event from the properties in the iCal (.ICS) format.

Syntax

def export_ics() -> str: ...

Remarks

The export_ics method is used to create a calendar object and export it in the iCal/ICS format, which can then be saved to disk and imported using any calendar software, even those that do not support CalDAV. The export_ics method will create the exact same data as the create_event method sends when adding or updating an event to a calendar.

Note that if export_ics is called immediately after a successful get_event, the unmodified calendar returned from the CalDAV server will be returned. However if any properties are changed between the get_event and export_ics calls, the class will generate and return a brand new event.

The following properties are used when creating a request with create_event or export_ics, and will be filled after calling get_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.

• alarms
• attendees
• categories
• classification
• completed
• Created
• custom_properties
• Depth
• description
• duration
• end_date
• event_type
• last_modified
• location
• organizer
• priority
• recurrence
• sequence
• start_date
• status
• summary
• timestamp
• timezone
• transparency
• uid
• url

get_calendar_options Method

Retrieves options for the ResourceURI to determines whether it supports calendar access.

Syntax

def get_calendar_options(resource_uri: str) -> None: ...

Remarks

This method sends an OPTIONS HTTP request to the indicated ResourceURI. The server will respond with an 200 OK HTTP message, and the supported options will fire one-by-one in the on_header event. If a server supports CalDAV calendar access, the "DAV" header will contain the string "calendar-access". The allowable CalDAV and WebDAV methods may also be returned in the "Allow" header.

For instance, the following headers may be returned from a call to the get_calendar_options method:

There is no standard format for resource URIs. Google for instance, uses "https://apidata.googleusercontent.com/caldav/v2/" plus your email address to access the default calendar. So "https://apidata.googleusercontent.com/caldav/v2/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://apidata.googleusercontent.com/caldav/v2/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://apidata.googleusercontent.com/caldav/v2/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 create_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_event. For example: CalDAV.UID = "1234567890"; CalDAV.CreateEvent("https://apidata.googleusercontent.com/caldav/v2/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: CalDAV.User = "username"; CalDAV.Password = "password"; CalDAV.CreateCalendar("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/", "My Hockey Calendar", "My 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.CreateEvent("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/qwerty1234567.ics"); CalDAV.GetCalendarReport("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/");

get_calendar_report Method

Generates a report on the indicated calendar collection resource.

Syntax

def get_calendar_report(resource_uri: str) -> None: ...

Remarks

This method is used to send a calendar-query request to the calendar located at the specified ResourceURI. The report_filter can be used to filter out and return only the calendar events you wish to receive. The response to a calendar-query report will be parsed by the class, and information about the individual events contained within shall be fired in the on_event_details event.

The following properties are used when creating a request with create_event or export_ics, and will be filled after calling get_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.

• alarms
• attendees
• categories
• classification
• completed
• Created
• custom_properties
• Depth
• description
• duration
• end_date
• event_type
• last_modified
• location
• organizer
• priority
• recurrence
• sequence
• start_date
• status
• summary
• timestamp
• timezone
• transparency
• uid
• url

For example: CalDAV.User = "myusername" CalDAV.Password = "mypassword" CalDAV.ReportFilterStartDate = "20090101T000000Z" CalDAV.ReportFilterEndDate = "20091231T230000Z" CalDAV.GetCalendarReport "https://caldav.calendar.yahoo.com/dav/username/Calendar/default_calendar/" The following code inside the on_event_details event will print the start and end time as well as the summary for each event: Private Sub CalDAV_EventDetails(ResourceURI As String, ResponseStatus As String, ETag As String, CalendarData As String, Summary As String) Debug.Print Summary & ": " & CalDAV.StartDate & " to " & CalDAV.EndDate End Sub The output from the above code will look something like this:

	Carolina Hurricanes vs. Colorado Avalanche: 20090222T150000 to 20090222T180000
	Lone Rider Brewery Tour: 20091107T124500 to 20091107T134500
	Salsa Dancing: 20090927T154500 to 20090927T181500
	Superbowl Party: 20090201T170000 to 20090202T000000
	Kathy's Birthday: 20090608T010000 to 20090608T020000
	Dinner at Shannon's: 20091001T183000 to 20091001T203000
	Carolina Rollergirls match: 20090411T170000 to 20090411T180000

There is no standard format for resource URIs. Google for instance, uses "https://apidata.googleusercontent.com/caldav/v2/" plus your email address to access the default calendar. So "https://apidata.googleusercontent.com/caldav/v2/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://apidata.googleusercontent.com/caldav/v2/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://apidata.googleusercontent.com/caldav/v2/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 create_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_event. For example: CalDAV.UID = "1234567890"; CalDAV.CreateEvent("https://apidata.googleusercontent.com/caldav/v2/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: CalDAV.User = "username"; CalDAV.Password = "password"; CalDAV.CreateCalendar("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/", "My Hockey Calendar", "My 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.CreateEvent("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/qwerty1234567.ics"); CalDAV.GetCalendarReport("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/");

get_event Method

Retrieves a single event from the CalDAV server.

Syntax

def get_event(resource_uri: str) -> None: ...

Remarks

This method retrieves a single event from a CalDAV server. The ResourceURI points to the exact location of the iCal (*.ics) file you wish to retrieve. (If you do not know the URL of the event you need, you can use the get_calendar_report method along with the report_filter property to find it.)

The event will be retrieved using the WebDAV GET method. The full response is delivered through the on_transfer event and the HTTP response headers through the on_header event. After an event is retrieved with this method, the class parses the calendar data into properties. You may then edit these properties and use create_event to update the calendar event resource.

The following properties are used when creating a request with create_event or export_ics, and will be filled after calling get_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.

• alarms
• attendees
• categories
• classification
• completed
• Created
• custom_properties
• Depth
• description
• duration
• end_date
• event_type
• last_modified
• location
• organizer
• priority
• recurrence
• sequence
• start_date
• status
• summary
• timestamp
• timezone
• transparency
• uid
• url

There is no standard format for resource URIs. Google for instance, uses "https://apidata.googleusercontent.com/caldav/v2/" plus your email address to access the default calendar. So "https://apidata.googleusercontent.com/caldav/v2/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://apidata.googleusercontent.com/caldav/v2/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://apidata.googleusercontent.com/caldav/v2/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 create_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_event. For example: CalDAV.UID = "1234567890"; CalDAV.CreateEvent("https://apidata.googleusercontent.com/caldav/v2/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: CalDAV.User = "username"; CalDAV.Password = "password"; CalDAV.CreateCalendar("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/", "My Hockey Calendar", "My 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.CreateEvent("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/qwerty1234567.ics"); CalDAV.GetCalendarReport("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/");

get_free_busy_report Method

Generates a report as to when the calendar owner is free and/or busy.

Syntax

def get_free_busy_report(resource_uri: str) -> None: ...

Remarks

This method sends a free-busy-query request to the calendar at the specified ResourceURI. . The CalDAV server will return a list of FREEBUSY elements, which will be fired in the on_free_busy event and also stored in the free_busy collection. Each FREEBUSY element contains a type (BUSY, FREE, BUSY-TENTATIVE, etc.) and a date range.

Note that the report_filter_start_date property is required for a Free/Busy report. The report_filter_end_date property is optional. These are the only two report_filters used by the get_free_busy_report request, all other filters will be ignored.

Note that Google Calendar does not currently support Free/Busy reporting.

There is no standard format for resource URIs. Google for instance, uses "https://apidata.googleusercontent.com/caldav/v2/" plus your email address to access the default calendar. So "https://apidata.googleusercontent.com/caldav/v2/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://apidata.googleusercontent.com/caldav/v2/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://apidata.googleusercontent.com/caldav/v2/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 create_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_event. For example: CalDAV.UID = "1234567890"; CalDAV.CreateEvent("https://apidata.googleusercontent.com/caldav/v2/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: CalDAV.User = "username"; CalDAV.Password = "password"; CalDAV.CreateCalendar("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/", "My Hockey Calendar", "My 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.CreateEvent("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/qwerty1234567.ics"); CalDAV.GetCalendarReport("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/");

import_ics Method

Imports calendar data (contained in an ICS file) into the class's property list.

Syntax

def import_ics(calendar_data: str) -> None: ...

Remarks

This method is used to load calendar data from an external source into the class. You may then submit this data with a call to create_event. If you edit any of the class properties between importing and calling create_event, the class will re-generate the PUT request itself. If no properties are changed, the imported data will be submitted unaltered when calling create_event.

As the calendar data is imported, the class will scan CalendarData for any calendar events. Each time a calendar event is discovered, the on_event_details event will fire, and the calendar event properties will be updated.

After import_ics completes, the calendar event properties will be set to the most recent calendar event found in CalendarData.

interrupt Method

This method interrupts the current method.

Syntax

def interrupt() -> None: ...

Remarks

If there is no method in progress, interrupt simply returns, doing nothing.

list_calendars Method

Lists all calendars that the current user can access.

Syntax

def list_calendars(base_url: str) -> None: ...

Remarks

This method lists all calendars the user can access.

The BaseURL parameter must be set to the base CalDAV URL for the server. For instance in the case of Google this is https://apidata.googleusercontent.com/caldav/v2. Other servers may use a format like https://mydavserver/.well-known/caldav/.

When this method is called the class will automatically perform a series of requests to obtain the calendar list. First, the class will send a PROPFIND request to the specified base URL to obtain the current-user-principle. Once the current user has been found, the class will then use that information to send a second PROPFIND request to get calendar-home-set for the user. The calendar-home-set is then be used by the class to make a final PROPFIND request to get the list of calendars for the user.

Once this method returns, the class will populate the Calendar* properties. For example:

calDAV.ListCalendars("https://apidata.googleusercontent.com/caldav/v2"); for (int i = 0; i < calDAV.Calendars.Count; i++) { string url = calDAV.Calendars[i].URL; string displayName = calDAV.Calendars[i].DisplayName; ... }

lock_calendar Method

Obtain a lock for a specified calendar resource.

Syntax

def lock_calendar(resource_uri: str) -> None: ...

Remarks

This method will request a new lock to be placed on ResourceURI in the user's name so that only the user can operate on it. The method is linked to a number of properties that it uses to generate the lock request:

This method is associated with the Depth property. If Depth is set to "0", the class will lock only ResourceURI and its properties. If Depth is set to "infinity", the class will lock ResourceURI and its entire subtree.

If move_event or copy_event are used to place a resource or collection in a location under a resource locked with "infinity", the new resource or collection will be added to the lock. Any lock on a collection will prevent non-lock owners from adding resources to that collection.

Note that while the Yahoo CalDAV server does accept lock_calendar and un_lock_calendar requests, the server does not respect resource locks (either on events or on the entire calendar). The Google CalDAV sever does not support either of these requests, and will respond with an HTTP protocol error: 405 Method Not Allowed. Also, neither Yahoo nor Google CalDAV servers support copying or moving calendar resources.

move_event Method

Moves one calendar resource to a new location.

Syntax

def move_event(source_resource_uri: str, destination_resource_uri: str) -> None: ...

Remarks

This method will move the resource indicated by SourceResourceURI to a new location under the resource indicated by DestinationResourceURI.

This method is associated with the Depth property. If Depth is set to "0", the class will move only SourceResourceURI. If Depth is set to "infinity", the class will move SourceResourceURI and its entire subtree to locations relative to it.

If the user has acquired a lock of infinite depth (via lock_calendar) on either DestinationResourceURI or any collection it is under, SourceResourceURI will be added to that lock.

Note that neither Yahoo nor Google CalDAV servers support locking, copying, or moving calendar resources.

There is no standard format for resource URIs. Google for instance, uses "https://apidata.googleusercontent.com/caldav/v2/" plus your email address to access the default calendar. So "https://apidata.googleusercontent.com/caldav/v2/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://apidata.googleusercontent.com/caldav/v2/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://apidata.googleusercontent.com/caldav/v2/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 create_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_event. For example: CalDAV.UID = "1234567890"; CalDAV.CreateEvent("https://apidata.googleusercontent.com/caldav/v2/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: CalDAV.User = "username"; CalDAV.Password = "password"; CalDAV.CreateCalendar("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/", "My Hockey Calendar", "My 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.CreateEvent("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/qwerty1234567.ics"); CalDAV.GetCalendarReport("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/");

reset Method

Reset the class.

Syntax

def reset() -> None: ...

Remarks

This method will reset the class's properties to their default values.

send_custom_request Method

Sends a request to the CalDAV server to do CRUD operations.

Syntax

def send_custom_request(http_method: str, url: str, request_body: str) -> None: ...

Remarks

Allows users to send personalized HTTP commands to a CalDAV server. It requires three string parameters: HTTPMethod indicates the desired action (e.g., "GET," "POST"), url specifies the target resource's URL, and RequestBody includes data sent with the request. Here is an example of how to create a calendar event: string httpMethod = "MKCALENDAR"; string url = "https://caldav.calendar.yahoo.com/dav/user/Calendar/CreateCalendarTest"; string requestBody = "BEGIN:VCALENDAR PRODID:/n software IPWorks CalDAV Component - www.nsoftware.com VERSION:2.0 BEGIN:VEVENT UID: uidValue DTSTAMP: dtstampValue DTSTART: dtstartValue DTEND: dtendValue PRIORITY:0 SEQUENCE:0 SUMMARY:TEST END:VEVENT END:VCALENDAR" calDAV.SendCustomRequest(httpMethod, url, requestBody);

un_lock_calendar Method

Unlocks a calendar resource.

Syntax

def un_lock_calendar(resource_uri: str) -> None: ...

Remarks

This method unlocks a calendar resource. Before calling un_lock_calendar on a particular calendar resource, the lock_token property must be set to the lock token for ResourceURI. The method will remove the lock, allowing other users or non-privileged users to access and operate on the file.

update_calendar Method

Updates a calendar collection resource.

Syntax

def update_calendar(resource_uri: str, cal_index: int) -> None: ...

Remarks

This method updates an existing calendar collection at the specified ResourceURI. To successfully update a calendar, the ResourceURI should already exist, and must point to a valid location where a calendar is saved. This method requires the specified calendar collection index. Use list_calendars and search through calendars to find the index of the calendar to be updated.

The following example shows how to update a calendar collection resource: CalDAV.CreateCalendar("https://caldav.calendar.yahoo.com/dav/userid/Calendar/TestCal1", "test", "test"); calDAV.Calendars[0].DisplayName = "test_updated"; calDAV.Calendars[0].Color = "#000001"; calDAV.UpdateCalendar("https://caldav.calendar.yahoo.com/dav/userid/Calendar/TestCal1", 0);

Note that Google does not support updating a calendar through CalDAV. It must be updated through the Google calendar web interface.

There is no standard format for resource URIs. Google for instance, uses "https://apidata.googleusercontent.com/caldav/v2/" plus your email address to access the default calendar. So "https://apidata.googleusercontent.com/caldav/v2/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://apidata.googleusercontent.com/caldav/v2/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://apidata.googleusercontent.com/caldav/v2/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 create_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_event. For example: CalDAV.UID = "1234567890"; CalDAV.CreateEvent("https://apidata.googleusercontent.com/caldav/v2/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: CalDAV.User = "username"; CalDAV.Password = "password"; CalDAV.CreateCalendar("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/", "My Hockey Calendar", "My 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.CreateEvent("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/qwerty1234567.ics"); CalDAV.GetCalendarReport("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/");

update_event Method

Updates a calendar resource at the specified ResourceURI using the CalDAV PUT method.

Syntax

def update_event(resource_uri: str) -> None: ...

Remarks

This method updates an existing event to the calendar collection at the specified ResourceURI. The ResourceURI must be a fully qualified URL to the location on the CalDAV server to which this event is saved.

NOTE: Some CalDAV servers (Yahoo for example) require that the UID and the filename portion of the URI match. For example, if the UID is "hello_world" then the ResourceURI parameter of the update_event should be "https://caldav.calendar.yahoo.com/dav/user_name/Calendar/My_Calendar/hello_world.ics". If the UID and filename portion of the URI do not match, the Yahoo CalDAV server will return a "302 Found" response indicating that the requested resource resides under a different URI. (Meaning the event was not added to the calendar). NextCloud on the other hand doesn't have this requirement.

The following properties are used when creating a request with create_event or export_ics, and will be filled after calling get_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.

• alarms
• attendees
• categories
• classification
• completed
• Created
• custom_properties
• Depth
• description
• duration
• end_date
• event_type
• last_modified
• location
• organizer
• priority
• recurrence
• sequence
• start_date
• status
• summary
• timestamp
• timezone
• transparency
• uid
• url

There is no standard format for resource URIs. Google for instance, uses "https://apidata.googleusercontent.com/caldav/v2/" plus your email address to access the default calendar. So "https://apidata.googleusercontent.com/caldav/v2/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://apidata.googleusercontent.com/caldav/v2/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://apidata.googleusercontent.com/caldav/v2/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 create_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_event. For example: CalDAV.UID = "1234567890"; CalDAV.CreateEvent("https://apidata.googleusercontent.com/caldav/v2/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: CalDAV.User = "username"; CalDAV.Password = "password"; CalDAV.CreateCalendar("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/", "My Hockey Calendar", "My 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.CreateEvent("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/qwerty1234567.ics"); CalDAV.GetCalendarReport("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/");

on_connected Event

Fired immediately after a connection completes (or fails).

Syntax

class CalDAVConnectedEventParams(object):
  @property
  def status_code() -> int: ...

  @property
  def description() -> str: ...

# In class CalDAV:
@property
def on_connected() -> Callable[[CalDAVConnectedEventParams], None]: ...
@on_connected.setter
def on_connected(event_hook: Callable[[CalDAVConnectedEventParams], None]) -> None: ...

Remarks

If the connection is made normally, StatusCode is 0 and Description is "OK".

If the connection fails, StatusCode has the error code returned by the Transmission Control Protocol (TCP)/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.

Please refer to the Error Codes section for more information.

on_connection_status Event

Fired to indicate changes in the connection state.

Syntax

class CalDAVConnectionStatusEventParams(object):
  @property
  def connection_event() -> str: ...

  @property
  def status_code() -> int: ...

  @property
  def description() -> str: ...

# In class CalDAV:
@property
def on_connection_status() -> Callable[[CalDAVConnectionStatusEventParams], None]: ...
@on_connection_status.setter
def on_connection_status(event_hook: Callable[[CalDAVConnectionStatusEventParams], None]) -> None: ...

Remarks

This event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake.

The ConnectionEvent parameter indicates the type of connection event. Values may include the following:

on_disconnected Event

Fired when a connection is closed.

Syntax

class CalDAVDisconnectedEventParams(object):
  @property
  def status_code() -> int: ...

  @property
  def description() -> str: ...

# In class CalDAV:
@property
def on_disconnected() -> Callable[[CalDAVDisconnectedEventParams], None]: ...
@on_disconnected.setter
def on_disconnected(event_hook: Callable[[CalDAVDisconnectedEventParams], None]) -> None: ...

Remarks

If the connection is broken normally, StatusCode is 0 and Description is "OK".

If the connection is broken for any other reason, StatusCode has the error code returned by the Transmission Control Protocol (TCP/IP) subsystem. Description contains a description of this code. The value of StatusCode is equal to the value of the TCP/IP error.

Please refer to the Error Codes section for more information.

on_end_transfer Event

This event is fired when a document finishes transferring.

Syntax

class CalDAVEndTransferEventParams(object):
  @property
  def direction() -> int: ...

# In class CalDAV:
@property
def on_end_transfer() -> Callable[[CalDAVEndTransferEventParams], None]: ...
@on_end_transfer.setter
def on_end_transfer(event_hook: Callable[[CalDAVEndTransferEventParams], None]) -> None: ...

Remarks

The on_end_transfer event is fired when the document text finishes transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

on_error Event

Fired when information is available about errors during data delivery.

Syntax

class CalDAVErrorEventParams(object):
  @property
  def error_code() -> int: ...

  @property
  def description() -> str: ...

# In class CalDAV:
@property
def on_error() -> Callable[[CalDAVErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[CalDAVErrorEventParams], None]) -> None: ...

Remarks

The on_error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

on_event_details Event

Fires for each calendar event received.

Syntax

class CalDAVEventDetailsEventParams(object):
  @property
  def resource_uri() -> str: ...

  @property
  def response_status() -> str: ...

  @property
  def e_tag() -> str: ...

  @property
  def calendar_data() -> str: ...

  @property
  def summary() -> str: ...

# In class CalDAV:
@property
def on_event_details() -> Callable[[CalDAVEventDetailsEventParams], None]: ...
@on_event_details.setter
def on_event_details(event_hook: Callable[[CalDAVEventDetailsEventParams], None]) -> None: ...

Remarks

This event fires for each VEVENT, VTODO, VJOURNAL, or VFREEBUSY event received in response to a get_calendar_report request. The ResourceURI parameter indicates the location of this particular event on the CalDAV server, and the ETag parameter is used to indicate the current state of the calendar event. If the ETag is different from the value you have cached for the current ResourceURI, it means the event has changed on the server since the last time you updated your cache. ResponseStatus indicates the HTTP status of CalDAV server received when attempting to retrieve this particular ResourceURI when it was building the report. The CalendarData parameter contains the raw calendar entry as returned by the CalDAV server. This data is also parsed into the following properties, and are valid for the current ResourceURI only inside this event. The Summary parameter indicates the summary of this particular calendar event.

• alarms
• attendees
• categories
• classification
• completed
• Created
• custom_properties
• Depth
• description
• duration
• end_date
• related_to
• event_type
• last_modified
• location
• organizer
• priority
• recurrence
• sequence
• start_date
• status
• summary
• timestamp
• timezone
• transparency
• uid
• url

Note that for a large calendar you may not wish to return the full contents of each calendar event, as this could be a substantially large amount of data. In this case, set the report_filter_return_calendar_data property to false, and only the ResourceURI, ResponseStatus, and ETag parameters will be returned by the CalDAV server for each calendar event. The contents of the event will not be returned, and the CalendarData parameter will be empty.

*The ResourceURI and the url property are not the same. The url property is an iCal field, and the ResourceURI is the actual location of the resource on the CalDAV server. Some CalDAV servers may force the url to match the ResourceURI, but the url should be treated as a separate user-defined entity by the user, and it should not be expected to match the ResourceURI. Likewise, ResponseStatus and status are not the same. status is the status of the event (TENTATIVE, CONFIRMED, CANCELLED, etc). ResponseStatus is the HTTP status received when the CalDAV server attempted to retrieve the current event when constructing a report.

on_free_busy Event

Fires for each Free/Busy element received in the response.

Syntax

class CalDAVFreeBusyEventParams(object):
  @property
  def busy_type() -> str: ...

  @property
  def busy_range() -> str: ...

# In class CalDAV:
@property
def on_free_busy() -> Callable[[CalDAVFreeBusyEventParams], None]: ...
@on_free_busy.setter
def on_free_busy(event_hook: Callable[[CalDAVFreeBusyEventParams], None]) -> None: ...

Remarks

This event fires for each FREEBUSY element received in response to a get_free_busy_report request. The FBTYPE will be contained in the BusyType parameter, and the FREEBUSY value itself will be contained in the BusyRange parameter. The Free/Busy information will also be stored in the free_busy collection.

on_header Event

Fired every time a header line comes in.

Syntax

class CalDAVHeaderEventParams(object):
  @property
  def field() -> str: ...

  @property
  def value() -> str: ...

# In class CalDAV:
@property
def on_header() -> Callable[[CalDAVHeaderEventParams], None]: ...
@on_header.setter
def on_header(event_hook: Callable[[CalDAVHeaderEventParams], None]) -> None: ...

Remarks

The Field parameter contains the name of the HTTP header (which is the same as it is delivered). The Value parameter contains the header contents.

If the header line being retrieved is a continuation header line, then the Field parameter contains "" (empty string).

on_log Event

Fired once for each log message.

Syntax

class CalDAVLogEventParams(object):
  @property
  def log_level() -> int: ...

  @property
  def message() -> str: ...

  @property
  def log_type() -> str: ...

# In class CalDAV:
@property
def on_log() -> Callable[[CalDAVLogEventParams], None]: ...
@on_log.setter
def on_log(event_hook: Callable[[CalDAVLogEventParams], None]) -> None: ...

Remarks

This event is fired once for each log message generated by the class. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the level of message. Possible values are as follows:

The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

Message is the log entry.

LogType identifies the type of log entry. Possible values are as follows:

• "Info"
• "RequestHeaders"
• "ResponseHeaders"
• "RequestBody"
• "ResponseBody"
• "ProxyRequest"
• "ProxyResponse"
• "FirewallRequest"
• "FirewallResponse"

on_redirect Event

Fired when a redirection is received from the server.

Syntax

class CalDAVRedirectEventParams(object):
  @property
  def location() -> str: ...

  @property
  def accept() -> bool: ...
  @accept.setter
  def accept(value) -> None: ...

# In class CalDAV:
@property
def on_redirect() -> Callable[[CalDAVRedirectEventParams], None]: ...
@on_redirect.setter
def on_redirect(event_hook: Callable[[CalDAVRedirectEventParams], None]) -> None: ...

Remarks

This event is fired in cases in which the client can decide whether or not to continue with the redirection process. The Accept parameter is always True by default, but if you do not want to follow the redirection, Accept may be set to False, in which case the class fails with an error. Location is the location to which the client is being redirected. Further control over redirection is provided in the follow_redirects property.

on_set_cookie Event

Fired for every cookie set by the server.

Syntax

class CalDAVSetCookieEventParams(object):
  @property
  def name() -> str: ...

  @property
  def value() -> str: ...

  @property
  def expires() -> str: ...

  @property
  def domain() -> str: ...

  @property
  def path() -> str: ...

  @property
  def secure() -> bool: ...

# In class CalDAV:
@property
def on_set_cookie() -> Callable[[CalDAVSetCookieEventParams], None]: ...
@on_set_cookie.setter
def on_set_cookie(event_hook: Callable[[CalDAVSetCookieEventParams], None]) -> None: ...

Remarks

This event is fired for every Set-Cookie: header received from the HTTP server.

The Name parameter contains the name of the cookie, with the corresponding value supplied in the Value parameter.

The Expires parameter contains an expiration time for the cookie (if provided by the server). The time format used is "Weekday, DD-Mon-YY HH:MM:SS GMT". If the server does not provide an expiration time, the Expires parameter will be an empty string. In this case, the convention is to drop the cookie at the end of the session.

The Domain parameter contains a domain name to limit the cookie to (if provided by the server). If the server does not provide a domain name, the Domain parameter will be an empty string. The convention in this case is to use the server specified in the URL (url_server) as the cookie domain.

The Path parameter contains a path name to limit the cookie to (if provided by the server). If the server does not provide a cookie path, the Path parameter will be an empty string. The convention in this case is to use the path specified in the URL (url_path) as the cookie path.

The Secure parameter specifies whether the cookie is secure. If the value of this parameter is True, the cookie value must be submitted only through a secure (HTTPS) connection.

on_ssl_server_authentication Event

Fired after the server presents its certificate to the client.

Syntax

class CalDAVSSLServerAuthenticationEventParams(object):
  @property
  def cert_encoded() -> bytes: ...

  @property
  def cert_subject() -> str: ...

  @property
  def cert_issuer() -> str: ...

  @property
  def status() -> str: ...

  @property
  def accept() -> bool: ...
  @accept.setter
  def accept(value) -> None: ...

# In class CalDAV:
@property
def on_ssl_server_authentication() -> Callable[[CalDAVSSLServerAuthenticationEventParams], None]: ...
@on_ssl_server_authentication.setter
def on_ssl_server_authentication(event_hook: Callable[[CalDAVSSLServerAuthenticationEventParams], None]) -> None: ...

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

on_ssl_status Event

Fired when secure connection progress messages are available.

Syntax

class CalDAVSSLStatusEventParams(object):
  @property
  def message() -> str: ...

# In class CalDAV:
@property
def on_ssl_status() -> Callable[[CalDAVSSLStatusEventParams], None]: ...
@on_ssl_status.setter
def on_ssl_status(event_hook: Callable[[CalDAVSSLStatusEventParams], None]) -> None: ...

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

on_start_transfer Event

This event is fired when a document starts transferring (after the headers).

Syntax

class CalDAVStartTransferEventParams(object):
  @property
  def direction() -> int: ...

# In class CalDAV:
@property
def on_start_transfer() -> Callable[[CalDAVStartTransferEventParams], None]: ...
@on_start_transfer.setter
def on_start_transfer(event_hook: Callable[[CalDAVStartTransferEventParams], None]) -> None: ...

Remarks

The on_start_transfer event is fired when the document text starts transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

on_status Event

Fired when the HTTP status line is received from the server.

Syntax

class CalDAVStatusEventParams(object):
  @property
  def http_version() -> str: ...

  @property
  def status_code() -> int: ...

  @property
  def description() -> str: ...

# In class CalDAV:
@property
def on_status() -> Callable[[CalDAVStatusEventParams], None]: ...
@on_status.setter
def on_status(event_hook: Callable[[CalDAVStatusEventParams], None]) -> None: ...

Remarks

HTTPVersion is a string containing the HTTP version string as returned from the server (e.g., "1.1").

StatusCode contains the HTTP status code (e.g., 200), and Description the associated message returned by the server (e.g., "OK").

on_transfer Event

Fired while a document transfers (delivers document).

Syntax

class CalDAVTransferEventParams(object):
  @property
  def direction() -> int: ...

  @property
  def bytes_transferred() -> int: ...

  @property
  def percent_done() -> int: ...

  @property
  def text() -> bytes: ...

# In class CalDAV:
@property
def on_transfer() -> Callable[[CalDAVTransferEventParams], None]: ...
@on_transfer.setter
def on_transfer(event_hook: Callable[[CalDAVTransferEventParams], None]) -> None: ...

Remarks

The Text parameter contains the portion of the document text being received. It is empty if data are being posted to the server.

The BytesTransferred parameter contains the number of bytes transferred in this Direction since the beginning of the document text (excluding HTTP response headers).

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

CalDAV Config Settings

CalDAV Config Settings

WebDAV Config Settings

<firstlevel>
  <one>value</one>
  <two>
    <item>first</item>
    <item>second</item>
  </two>
  <three>value three</three>
</firstlevel>

{
  "firstlevel": {
    "one": "value",
    "two": ["first", "second"],
    "three": "value three"
  }
}