IPWorks 2022 Python Edition
Version 22.0 [Build 8369]

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 calendaring and scheduling information based on the iCalendar format.

Syntax

class ipworks.CalDAV

Remarks

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

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

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

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

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

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

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

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

These methods all act upon the calendar collection resource (the calendar itself): The lock_calendar and un_lock_calendar methods may operate on individual events or on the whole calendar.

There is no standard format for resource URIs. Google for instance, uses "https://www.google.com/calendar/dav/" plus your email address to access the default calendar. So "https://www.google.com/calendar/dav/username@gmail.com/" is the base URI for the default calendar. If you have multiple calendars, replace the email address portion above with the Id of the calendar, plus "@group.calendar.google.com/". For instance: "https://www.google.com/calendar/dav/ev3nkr4ua83jej7q32oumn5eeo@group.calendar.google.com/". For Google, calendar events are stored in the "/events/" path. To retrieve a report on a calendar, you'd add "/events/" to one of the above paths. For example: CalDAV.GetCalendarReport("https://www.google.com/calendar/dav/username@gmail.com/events/"); Leaving the "/events/" out of the URI will result in an HTTP protocol error: 405 Method not allowed.

To add or retrieve an event, add the UID of the event you're creating or retrieving plus ".ics" to the path. Note that when putting an event with the put_calendar_event method, if the resourceURI and the UID do not match Google will create the event using the UID stored in the uid property. The actual location of will be newly added event will be returned in a "Location" header. This is the resource URI you must use to retrieve the event with get_calendar_event. For example: CalDAV.UID = "1234567890"; CalDAV.PutCalendarEvent("https://www.google.com/calendar/dav/username@gmail.com/events/1234567890.ics");

Yahoo uses a different format for CalDAV access. Yahoo's ResourceURIs always start with "https://caldav.calendar.yahoo.com/dav/" plus your user name, plus "/Calendar/" plus the name of your calendar. For instance: "https://caldav.calendar.yahoo.com/dav/username/Calendar/Your_Name" for the default calendar. (Yahoo uses your name to create the default calendar). When using the create_calendar event to create a new calendar, replace "Your_Name" in the URI with the desired name of your new calendar. Event resources are located directly under the "/Calendar/Calendar_Name/" path. Like Google, the UID and filename portion of the resource URI must match, but Yahoo will actually return an HTTP protocol error if they differ. The examples below show a few possible transactions: CalDAVS1.User = "username"; CalDAVS1.Password = "password"; CalDAV.DisplayName = "My Hockey Calendar"; CalDAV.CreateCalendar("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/"); CalDAV.StartDate = "20100401T040000"; CalDAV.EndDate = "20100401T060000"; CalDAV.UID = "qwerty1234567"; CalDAV.Summary = "First Practice"; CalDAV.Location = "Rink on 1st and main"; CalDAV.EventType = vEvent; CalDAV.PutCalendarEvent("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/qwerty1234567.ics"); CalDAV.GetCalendarReport("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/");

Property List


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

alarm_countThe number of records in the Alarm arrays.
alarm_actionThis property determines what the CalDAV server will do when the alarm Trigger is reached.
alarm_attachmentThis property contains a sound file attached to the alarm.
alarm_attachment_typeThis property contains the MIME-Type of the attachment.
alarm_durationThis property contains the interval between repeating alarms.
alarm_messageThis property contains a message used to alert the user when this alarm is triggered.
alarm_recipientThis property contains the email address of the person to be alerted when this alarm is triggered.
alarm_repeatThis property contains the number of times the alarm is to be repeated after the initial trigger.
alarm_subjectThis property contains the subject of the message used to alert the user when this alarm is triggered.
alarm_triggerThis property contains the time when the alarm is triggered.
attendeesDefines one or more participants that have been invited to the event.
authorizationThis property includes the Authorization string to be sent to the server.
auth_schemeThe authentication scheme to use when server authentication is required.
categoriesUsed to specify categories or subtypes of the calendar event.
classificationDefines the access classification for a calendar class.
completedDate and time that a to-do was actually completed.
connectedThis shows whether the class is connected.
cookie_countThe number of records in the Cookie arrays.
cookie_domainThis is the domain of a received cookie.
cookie_expirationThis property contains an expiration time for the cookie (if provided by the server).
cookie_nameThis property, contains the name of the cookie.
cookie_pathThis property contains a path name to limit the cookie to (if provided by the server).
cookie_secureThis property contains the security flag of the received cookie.
cookie_valueThis property contains the value of the cookie.
createdDate and time calendar information created.
custom_property_countThe number of records in the CustomProperty arrays.
custom_property_attributeThis property contains an optional attribute of the custom property.
custom_property_nameThis property contains the textual name of the custom property.
custom_property_valueThis property contains the value of the custom property.
depthThe depth associated with the current operation.
descriptionProvides a complete description of the calendar event.
display_nameProvides the display name of the calendar being created.
due_dateSpecifies the due date for a calendar event.
durationDuration of the calendar event.
end_dateSpecifies the date and time that a calendar event ends.
e_tagIdentifier returned by the CalDAV server which is used to synchronize edits.
event_typeIndicates the type of calendar object resource.
firewall_auto_detectThis property tells the class whether or not to automatically detect and use firewall system settings, if available.
firewall_typeThis property determines the type of firewall to connect through.
firewall_hostThis property contains the name or IP address of firewall (optional).
firewall_passwordThis property contains a password if authentication is to be used when connecting through the firewall.
firewall_portThis property contains the transmission control protocol (TCP) port for the firewall Host .
firewall_userThis property contains a user name if authentication is to be used connecting through a firewall.
follow_redirectsThis property determines what happens when the server issues a redirect.
free_busy_countThe number of records in the FreeBusy arrays.
free_busy_rangeContains the date/time range when the calendar owner is busy.
free_busy_typeIndicates the busy status of the corresponding BusyRange .
idleThe current status of the class.
last_modifiedThe date and time that the information associated with the calendar event was last revised in the calendar store.
local_hostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
locationDefines the intended venue for the activity defined by a calendar class.
lock_typeThe type of the current resource lock.
lock_ownerThe principle that owns the current resource lock.
lock_scopeThe scope of the current resource lock.
lock_timeoutThe time to live for the current resource lock.
lock_tokensThe lock string to be used when submitting operations on a locked resource.
organizerDefines the organizer of a calendar event.
other_headersThis property includes other headers as determined by the user (optional).
parsed_header_countThe number of records in the ParsedHeader arrays.
parsed_header_fieldThis property contains the name of the HTTP header (this is the same case as it is delivered).
parsed_header_valueThis property contains the header contents.
passwordThis property includes a password if authentication is to be used.
priorityDefines the relative priority for a calendar event.
proxy_auth_schemeThis property is used to tell the class which type of authorization to perform when connecting to the proxy.
proxy_auto_detectThis property tells the class whether or not to automatically detect and use proxy system settings, if available.
proxy_passwordThis property contains a password if authentication is to be used for the proxy.
proxy_portThis property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).
proxy_serverIf a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
proxy_sslThis property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.
proxy_userThis property contains a user name, if authentication is to be used for the proxy.
recurrence_datesIndividual dates on which the event will recur.
recurrence_exception_datesDefines the list of DATE-TIME exceptions to the recurrence set.
recurrence_exception_ruleDefines a rule or repeating pattern for an exception to the recurrence set.
recurrence_idIdentifies a recurring event.
recurrence_ruleThis property defines the recurrence rule for the event.
report_filter_alarm_endLimits the events returned in the report to only those with an alarm set in the range specified by AlarmStart and AlarmEnd .
report_filter_alarm_startLimits the events returned in the report to only those with an alarm set in the range specified by AlarmStart and AlarmEnd .
report_filter_custom_filterAllows the user to specify his own filter XML.
report_filter_end_dateLimits the events returned in the report to only those which occur in the time range specified by StartDate and EndDate .
report_filter_event_typeIndicates the type of calendar object resources to return in a Report.
report_filter_propertyLimits the events returned in a Report to only those which contain a matching property name and value.
report_filter_recur_endLimits the recurring events returned in the report.
report_filter_recur_startLimits the recurring events returned in the report.
report_filter_return_calendar_dataControls whether the contents of each calendar event is returned in the report.
report_filter_start_dateLimits the events returned in the report to only those which occur in the time range specified by StartDate and EndDate .
report_filter_uidLimits the recurring events returned in the report to only those with the specified UID.
sequenceDefines the revision sequence number of the event within a sequence of revisions.
ssl_accept_server_cert_encodedThis is the certificate (PEM/base64 encoded).
ssl_cert_encodedThis is the certificate (PEM/base64 encoded).
ssl_cert_storeThis is the name of the certificate store for the client certificate.
ssl_cert_store_passwordIf 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_typeThis is the type of certificate store for this certificate.
ssl_cert_subjectThis is the subject of the certificate used for client authentication.
ssl_providerThis specifies the SSL/TLS implementation to use.
ssl_server_cert_encodedThis is the certificate (PEM/base64 encoded).
start_dateSpecifies the date and time that an event begins.
statusDefines the overall status or confirmation for the calendar event.
status_lineThis property is the first line of the last server response.
summaryDefines a short summary or subject for the calendar event.
timeoutA timeout for the class.
timestampSpecifies the date and time that the instance of the event was created.
timezone_dst_nameThe customary name for the daylight-savings time zone.
timezone_dst_offset_fromThe UTC offset that is in use when the onset of this time zone observance begins.
timezone_dst_offset_toThe UTC offset for daylight savings time, when this observance is in use.
timezone_dst_ruleThis property defines the recurrence rule for the onset of this daylight savings time observance.
timezone_dst_startThe effective onset date and local time for the daylight-time time zone definition.
timezone_last_modifiedThis optional property is a UTC value that specifies the date and time that this time zone definition was last updated.
timezone_std_nameThe customary name for the standard time zone.
timezone_std_offset_fromThe UTC offset that is in use when the onset of this time zone observance begins.
timezone_std_offset_toThe UTC offset for standard time, when this observance is in use.
timezone_std_ruleThis property defines the recurrence rule for the onset of this standard time observance.
timezone_std_startThe effective onset date and local time for the standard-time time zone definition.
timezone_idThis property specifies a text value that uniquely identifies this CalTimezone calendar class.
timezone_urlOptionally points to a published time zone definition.
transparencyDefines whether or not an event is transparent to busy time searches.
uidA persistent, globally unique identifier for the calendar event.
urlLocation of the event resource on the CalDAV server.
userThis property includes a user name if authentication is to be used.

Method List


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

add_cookieThis method adds a cookie and the corresponding value to the outgoing request headers.
add_custom_propertyAdds a form variable and the corresponding value.
configSets or retrieves a configuration setting.
copy_calendar_eventCopy events to a new location.
create_calendarCreates a new calendar collection resource.
delete_calendar_eventDelete a resource or collection.
do_eventsProcesses events from the internal message queue.
export_icsGenerates an event from the properties in the iCal (.ICS) format.
get_calendar_eventRetrieves a single event from the CalDAV server.
get_calendar_optionsRetrieves options for the ResourceURI to determines whether it supports calendar access.
get_calendar_reportGenerates a report on the indicated calendar collection resource.
get_free_busy_reportGenerates a report as to when the calendar owner is free and/or busy.
import_icsImports iCal data (contained in an ICS file) into the class's property list.
interruptInterrupt the current method.
lock_calendarObtain a lock for a specified calendar resource.
move_calendar_eventMoves one calendar resource to a new location.
put_calendar_eventAdds a calendar resource at the specified ResourceURI using the CalDAV PUT method.
resetReset the class.
un_lock_calendarUnlocks a calendar resource.

Event List


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

on_connectedThis event is fired immediately after a connection completes (or fails).
on_connection_statusThis event is fired to indicate changes in the connection state.
on_disconnectedThis event is fired when a connection is closed.
on_end_transferFired when a document finishes transferring.
on_errorInformation about errors during data delivery.
on_event_detailsFires for each calendar event received.
on_free_busyFires for each Free/Busy element received in the response.
on_headerThis event is fired every time a header line comes in.
on_logThis event fires once for each log message.
on_redirectThis event is fired when a redirection is received from the server.
on_set_cookieThis event is fired for every cookie set by the server.
on_ssl_server_authenticationFired after the server presents its certificate to the client.
on_ssl_statusShows the progress of the secure connection.
on_start_transferFired when a document starts transferring (after the headers).
on_statusThis event is fired when the HTTP status line is received from the server.
on_transferThis event is fired while a document transfers (delivers document).

Config Settings


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

AuthSchemeThe authentication scheme to use for server authorization.
BuildEventBuilds the current event for a multi-event calendar entry.
EndCalendarSignifies the end of a multi-event calendar entry.
ExpandRecurringEventsInstructs the class to return all instances of a recurring event within a timeframe.
ProductIdSpecifies the identifier for the product that created the iCalendar object.
RecurrenceExceptionDatesAttrsSpecifies the attributes for the exception dates of a recurring event.
StartCalendarSignifies the beginning of a multi-event calendar entry.
EncodeURLIf set to true the URL will be encoded by the class.
IsDir[i]Whether or not the resource at the specified index is a directory.
AcceptEncodingUsed to tell the server which types of content encodings the client supports.
AllowHTTPCompressionThis property enables HTTP compression for receiving data.
AllowHTTPFallbackWhether HTTP/2 connections are permitted to fallback to HTTP/1.1.
AppendWhether to append data to LocalFile.
AuthorizationThe Authorization string to be sent to the server.
BytesTransferredContains the number of bytes transferred in the response data.
ChunkSizeSpecifies the chunk size in bytes when using chunked encoding.
CompressHTTPRequestSet to true to compress the body of a PUT or POST request.
EncodeURLIf set to True the URL will be encoded by the class.
FollowRedirectsDetermines what happens when the server issues a redirect.
GetOn302RedirectIf set to True the class will perform a GET on the new location.
HTTP2HeadersWithoutIndexingHTTP2 headers that should not update the dynamic header table with incremental indexing.
HTTPVersionThe version of HTTP used by the class.
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after completion of the request.
KerberosSPNThe Service Principal Name for the Kerberos Domain Controller.
LogLevelThe level of detail that is logged.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
NegotiatedHTTPVersionThe negotiated HTTP version.
OtherHeadersOther headers as determined by the user (optional).
ProxyAuthorizationThe authorization string to be sent to the proxy server.
ProxyAuthSchemeThe authorization scheme to be used for the proxy.
ProxyPasswordA password if authentication is to be used for the proxy.
ProxyPortPort for the proxy server (default 80).
ProxyServerName or IP address of a proxy server (optional).
ProxyUserA user name if authentication is to be used for the proxy.
SentHeadersThe full set of headers as sent by the client.
StatusLineThe first line of the last response from the server.
TransferredDataThe contents of the last response from the server.
TransferredDataLimitThe maximum number of incoming bytes to be stored by the class.
TransferredHeadersThe full set of headers as received from the server.
TransferredRequestThe full request as sent by the client.
UseChunkedEncodingEnables or Disables HTTP chunked encoding for transfers.
UseIDNsWhether to encode hostnames to internationalized domain names.
UsePlatformHTTPClientWhether or not to use the platform HTTP client.
UserAgentInformation about the user agent (browser).
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the class binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
TcpNoDelayWhether or not to delay when sending packets.
UseIPv6Whether to use IPv6.
LogSSLPacketsControls whether SSL packets are logged when using the internal security API.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCACertFilePathsThe paths to CA certificate files on Unix/Linux.
SSLCACertsA newline separated list of CA certificate to use during SSL client authentication.
SSLCheckCRLWhether to check the Certificate Revocation List for the server certificate.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLEnableRenegotiationWhether the renegotiation_info SSL extension is supported.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLKeyLogFileThe location of a file where per-session secrets are written for debugging purposes.
SSLNegotiatedCipherReturns the negotiated ciphersuite.
SSLNegotiatedCipherStrengthReturns the negotiated ciphersuite strength.
SSLNegotiatedCipherSuiteReturns the negotiated ciphersuite.
SSLNegotiatedKeyExchangeReturns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrengthReturns the negotiated key exchange algorithm strength.
SSLNegotiatedVersionReturns the negotiated protocol version.
SSLSecurityFlagsFlags that control certificate verification.
SSLServerCACertsA newline separated list of CA certificate to use during SSL server certificate validation.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
ProcessIdleEventsWhether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillisThe length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPITells the class whether or not to use the system security libraries or an internal implementation.

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:

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:

aAudio (0)Specifies an alarm that causes a sound to be played to alert the user. You may attach a custom sound file using the alarm_attachment property.
aDisplay (1)Specifies an alarm that causes a visual alert to be displayed to the user. If alarm_action is set to this value, you must also set the alarm_message property with the message to be displayed.
aEmail (2) Instructs the CalDAV sever to email a specified alarm_recipient. In this case, the alarm_message property will contain the message body of the email and the alarm_subject property should contain the subject line.

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:

AttachmentType File Extension Description
audio/basic au, snd basic audio, 8-bit u-law PCM.
audio/mid mid, rmi MIDI music data
audio/mpeg mp2, mp3 MPEG-1 Audio Layer II and III.
audio/x-aiff aiff, aif, aifcMacintosh audio format
audio/x-mp4a-latm m4a MPEG-4 Audio
audio/x-pn-realaudio ra, ram Realaudio
audio/x-wav wav Microsoft waveform audio
audio/x-ms-wma wma Windows Media Audio (Microsoft)

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:

P is the duration designator (historically called "period") placed at the start of the duration representation.
W is the week designator that follows the value for the number of weeks.
D is the day designator that follows the value for the number of days.
T is the time designator that precedes the time components of the representation.
H is the hour designator that follows the value for the number of hours.
M is the minute designator that follows the value for the number of minutes.
S is the second designator that follows the value for the number of seconds.

For example, "P4DT12H30M5S" represents a duration of four days, twelve hours, thirty minutes, and five seconds. Unused date/time designators may be left out completely. (A five-minute duration may be represented as simply "PT5M"). Also note that "PT36H" and "P1DT12H" represent the same duration.

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:

P is the duration designator (historically called "period") placed at the start of the duration representation.
W is the week designator that follows the value for the number of weeks.
D is the day designator that follows the value for the number of days.
T is the time designator that precedes the time components of the representation.
H is the hour designator that follows the value for the number of hours.
M is the minute designator that follows the value for the number of minutes.
S is the second designator that follows the value for the number of seconds.

Either a positive or negative duration may be specified for the alarm_trigger property. An alarm with a positive duration is triggered after the associated start of the event (or to-do). An alarm with a negative duration is triggered before the start of the event. For instance, the following code instructs an alarm to fire 10 minutes before the event starts: CalDAV.Alarm.Trigger = "-PT10M"

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_calendar_event, and is also used when creating an event to be added using the put_calendar_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

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.

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_calendar_event, and is also used when creating an event to be added using the put_calendar_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_calendar_event, and is also used when creating an event to be added using the put_calendar_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_calendar_event, and is also used when creating an event to be added using the put_calendar_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

This shows whether the class is connected.

Syntax

def get_connected() -> bool: ...
def set_connected(value: bool) -> None: ...

connected = property(get_connected, set_connected)

Default Value

FALSE

Remarks

This property is used to determine whether or not the class is connected to the remote host.

Note: It is recommended to use the connect or disconnect method instead of setting this property.

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:

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

cookie_domain Property

This is the domain of a received cookie.

Syntax

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

Default Value

""

Remarks

This is 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

This property contains an expiration time for the cookie (if provided by the server).

Syntax

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

Default Value

""

Remarks

This property 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, 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

This property, contains 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

This property, contains 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

This property contains 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

This property 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 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

This property contains the security flag of the received cookie.

Syntax

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

Default Value

FALSE

Remarks

This property contains 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

This property contains 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

This property contains 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.

created Property

Date and time calendar information created.

Syntax

def get_created() -> str: ...
def set_created(value: str) -> None: ...

created = property(get_created, set_created)

Default Value

""

Remarks

This property specifies the date and time that the calendar information was created by the calendar user agent in the calendar store. 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_calendar_event, and is also used when creating an event to be added using the put_calendar_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.

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:

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.

depth Property

The depth associated with the current operation.

Syntax

def get_depth() -> int: ...
def set_depth(value: int) -> None: ...

depth = property(get_depth, set_depth)

Default Value

0

Remarks

This property defines how deep to operate within a collection. When performing certain operations on resource collections, the class will use depth to instruct the server on how deep to operate within the collection. depth is an enumerated type with the following possible values:

dpUnspecified (0)The server will use the protocol default depth for the operation (this is normally "infinity").
dpResourceOnly (1)The server will operate only on the collection resource URI, and not on any of its internal member resources.
dpImmediateChildren (2)The server will operate on the collection resource URI and all of its immediate member resources (but on none of their member resources).
dpInfinity (3)The server will recursively operate on the target resource URI and all of its internal member URIs through all levels of the collection hierarchy.

depth is used when performing the following operations: lock_calendar, move_calendar_event, copy_calendar_event, and get_calendar_report

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. It is also used by the create_calendar method when creating a new calendar collection.

display_name Property

Provides the display name of the calendar being created.

Syntax

def get_display_name() -> str: ...
def set_display_name(value: str) -> None: ...

display_name = property(get_display_name, set_display_name)

Default Value

""

Remarks

This property provides the name to be displayed for a calendar. This may or may not be defined on any calendar collection. It should be set before creating a new calendar collection via the create_calendar method.

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:

P is the duration designator (historically called "period") placed at the start of the duration representation.
W is the week designator that follows the value for the number of weeks.
D is the day designator that follows the value for the number of days.
T is the time designator that precedes the time components of the representation.
H is the hour designator that follows the value for the number of hours.
M is the minute designator that follows the value for the number of minutes.
S is the second designator that follows the value for the number of seconds.

For example, "P4DT12H30M5S" represents a duration of four days, twelve hours, thirty minutes, and five seconds. Unused date/time designators may be left out completely. (A five-minute duration may be represented as simply "PT5M"). Also note that "PT36H" and "P1DT12H" represent the same duration.

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_calendar_event, and is also used when creating an event to be added using the put_calendar_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_calendar_event, and is also used when creating an event to be added using the put_calendar_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 put_calendar_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 put_calendar_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.PutCalendarEvent "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_calendar_event and update the most recent version.

This property is filled from the response to a get_calendar_event, and is also used when creating an event to be added using the put_calendar_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_calendar_event, and is also used when creating an event to be added using the put_calendar_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

This property tells the class whether or not 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

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

firewall_type Property

This property determines 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

This property determines the type of firewall to connect through. The applicable values are as follows:

fwNone (0)No firewall (default setting).
fwTunnel (1)Connect through a tunneling proxy. firewall_port is set to 80.
fwSOCKS4 (2)Connect through a SOCKS4 Proxy. firewall_port is set to 1080.
fwSOCKS5 (3)Connect through a SOCKS5 Proxy. firewall_port is set to 1080.
fwSOCKS4A (10)Connect through a SOCKS4A Proxy. firewall_port is set to 1080.

firewall_host Property

This property contains the name or IP address of 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

This property contains the name or IP address of 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

This property contains 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

This property contains 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

This property contains 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

This property contains 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

This property contains a user name if authentication is to be used 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

This property contains a user name if authentication is to be used connecting through a firewall. If the firewall_host is specified, this property and firewall_password properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

follow_redirects Property

This 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:

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:

P is the duration designator (historically called "period") placed at the start of the duration representation.
W is the week designator that follows the value for the number of weeks.
D is the day designator that follows the value for the number of days.
T is the time designator that precedes the time components of the representation.
H is the hour designator that follows the value for the number of hours.
M is the minute designator that follows the value for the number of minutes.
S is the second designator that follows the value for the number of seconds.

For example, "P4DT12H30M5S" represents a duration of four days, twelve hours, thirty minutes, and five seconds. Unused date/time designators may be left out completely. (A five-minute duration may be represented as simply "PT5M"). Also note that "PT36H" and "P1DT12H" represent the same duration.

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

idle will be False if the component is currently busy (communicating and/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_calendar_event, and is also used when creating an event to be added using the put_calendar_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

The local_host 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 multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

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 multi-homed 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_calendar_event, and is also used when creating an event to be added using the put_calendar_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:

"exclusive"The lock belongs exclusively to the requesting principle. No other principle may modify the locked resource URI.
"shared"The locked resource may not be modified by non-trusted principles. Users who have access rights, however, may request a shared lock which they can then use to modify or operate on the resource.

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_tokens Property

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

Syntax

def get_lock_tokens() -> str: ...
def set_lock_tokens(value: str) -> None: ...

lock_tokens = property(get_lock_tokens, set_lock_tokens)

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_tokens may be set to the tokens 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_tokens 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_calendar_event, and is also used when creating an event to be added using the put_calendar_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

This property includes 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 put_calendar_event or retrieving an event with get_calendar_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 put_calendar_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:

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_calendar_event, and is also used when creating an event to be added using the put_calendar_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

This property is used to tell the class which 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

This property is used to tell the class which 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 component 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

This property tells the class whether or not 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

This property tells the class whether or not to automatically detect and use proxy system settings, if available. The default value is False.

proxy_password Property

This property contains 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

This property contains 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 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

This property contains 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

This property contains 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

This property determines 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

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

psAutomatic (0)Default setting. If the url is an https URL, the class will use the psTunnel option. If the url is an http URL, the class will use the psNever option.
psAlways (1)The connection is always SSL enabled.
psNever (2)The connection is not SSL enabled.
psTunnel (3)The connection is made through a tunneling (HTTP) proxy.

proxy_user Property

This property contains a user name, 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

This property contains a user name, if authentication is to be used for the proxy.

If proxy_auth_scheme is set to Basic Authentication, the proxy_user and proxy_password 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.

FREQ The FREQ rule part identifies the type of recurrence rule. This rule part MUST be specified in the recurrence rule. Valid values include SECONDLY, to specify repeating events based on an interval of a second or more; MINUTELY, to specify repeating events based on an interval of a minute or more; HOURLY, to specify repeating events based on an interval of an hour or more; DAILY, to specify repeating events based on an interval of a day or more; WEEKLY, to specify repeating events based on an interval of a week or more; MONTHLY, to specify repeating events based on an interval of a month or more; and YEARLY, to specify repeating events based on an interval of a year or more.
UNTIL The UNTIL rule part defines a DATE (YYYYMMDD) or DATE-TIME (YYYYMMDDThhmmss) value that bounds the recurrence rule in an inclusive manner. If the value specified by UNTIL is synchronized with the specified recurrence, this DATE or DATE-TIME becomes the last instance of the recurrence. The value of the UNTIL rule part MUST have the same value type as the start_date property. Furthermore, if the start_date is specified as a date with local time, then the UNTIL rule part MUST also be specified as a date with local time. If the start_date property is specified as a date with UTC time or a date with local time and time zone reference, then the UNTIL rule part MUST be specified as a date with UTC time. If not present, and the COUNT rule part is also not present, the "recurrence_rule" is considered to repeat forever.
COUNT The COUNT rule part defines the number of occurrences at which to range-bound the recurrence. The start_date property value always counts as the first occurrence.
INTERVAL Positive integer representing at which intervals the recurrence rule repeats. The default value is "1", meaning every second for a SECONDLY rule, every minute for a MINUTELY rule, every hour for an HOURLY rule, etc. For example, within a DAILY rule, a value of "8" means every eight days.
BYSECOND The BYSECOND rule part specifies a COMMA-separated list of seconds within a minute. Valid values are 0 to 60.
BYMINUTE The BYMINUTE rule part specifies a COMMA-separated list of minutes within an hour. Valid values are 0 to 59.
BYHOUR The BYHOUR rule part specifies a COMMA-separated list of hours of the day. Valid values are 0 to 23.
BYDAY The BYDAY rule part specifies a COMMA-separated list of days of the week; SU indicates Sunday; MO indicates Monday; TU indicates Tuesday; WE indicates Wednesday; TH indicates Thursday; FR indicates Friday; and SA indicates Saturday. Each BYDAY value can also be preceded by a positive (+n) or negative (-n) integer. If present, this indicates the nth occurrence of a specific day within the MONTHLY or YEARLY recurrence_rule.
BYMONTHDAY The BYMONTHDAY rule part specifies a COMMA-separated list of days of the month. Valid values are 1 to 31 or -31 to -1. For example, -10 represents the tenth to the last day of the month. The BYMONTHDAY rule part MUST NOT be specified when the FREQ rule part is set to WEEKLY.
BYYEARDAY The BYYEARDAY rule part specifies a COMMA-separated list of days of the year. Valid values are 1 to 366 or -366 to -1. For example, -1 represents the last day of the year (December 31st) and -306 represents the 306th to the last day of the year (March 1st). The BYYEARDAY rule part MUST NOT be specified when the FREQ rule part is set to DAILY, WEEKLY, or MONTHLY.
BYWEEKNO The BYWEEKNO rule part specifies a COMMA-separated list of ordinals specifying weeks of the year. Valid values are 1 to 53 or -53 to -1. This corresponds to weeks according to week numbering as defined in ISO.8601.2004. A week is defined as a seven day period, starting on the day of the week defined to be the week start (see WKST). Week number one of the calendar year is the first week that contains at least four (4) days in that calendar year. This rule part MUST NOT be used when the FREQ rule part is set to anything other than YEARLY. For example, 3 represents the third week of the year.
BYMONTH The BYMONTH rule part specifies a COMMA-separated list of months of the year. Valid values are 1 to 12.
WKST Specifies the day on which the workweek starts. Valid values are MO, TU, WE, TH, FR, SA, and SU. This is significant when a WEEKLY recurrence_rule has an interval greater than 1, and a BYDAY rule part is specified. This is also significant when in a YEARLY recurrence_rule when a BYWEEKNO rule part is specified. The default value is MO.
BYSETPOSThe BYSETPOS rule part specifies a COMMA-separated list of values that corresponds to the nth occurrence within the set of recurrence instances specified by the rule. BYSETPOS operates on a set of recurrence instances in one interval of the recurrence rule. For example, in a WEEKLY rule, the interval would be one week A set of recurrence instances starts at the beginning of the interval defined by the FREQ rule part. Valid values are 1 to 366 or -366 to -1. It MUST only be used in conjunction with another BYxxx rule part. For example "the last work day of the month" could be represented as: FREQ=MONTHLY;BYDAY=MO,TU,WE,TH,FR;BYSETPOS=-1. Each BYSETPOS value can include a positive (+n) or negative (-n) integer. If present, this indicates the nth occurrence of the specific occurrence within the set of occurrences specified by the rule.

Note: The BYSECOND, BYMINUTE and BYHOUR rule parts MUST NOT be specified when the associated start_date property is specified.

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.

FREQ The FREQ rule part identifies the type of recurrence rule. This rule part MUST be specified in the recurrence rule. Valid values include SECONDLY, to specify repeating events based on an interval of a second or more; MINUTELY, to specify repeating events based on an interval of a minute or more; HOURLY, to specify repeating events based on an interval of an hour or more; DAILY, to specify repeating events based on an interval of a day or more; WEEKLY, to specify repeating events based on an interval of a week or more; MONTHLY, to specify repeating events based on an interval of a month or more; and YEARLY, to specify repeating events based on an interval of a year or more.
UNTIL The UNTIL rule part defines a DATE (YYYYMMDD) or DATE-TIME (YYYYMMDDThhmmss) value that bounds the recurrence rule in an inclusive manner. If the value specified by UNTIL is synchronized with the specified recurrence, this DATE or DATE-TIME becomes the last instance of the recurrence. The value of the UNTIL rule part MUST have the same value type as the start_date property. Furthermore, if the start_date is specified as a date with local time, then the UNTIL rule part MUST also be specified as a date with local time. If the start_date property is specified as a date with UTC time or a date with local time and time zone reference, then the UNTIL rule part MUST be specified as a date with UTC time. If not present, and the COUNT rule part is also not present, the "recurrence_rule" is considered to repeat forever.
COUNT The COUNT rule part defines the number of occurrences at which to range-bound the recurrence. The start_date property value always counts as the first occurrence.
INTERVAL Positive integer representing at which intervals the recurrence rule repeats. The default value is "1", meaning every second for a SECONDLY rule, every minute for a MINUTELY rule, every hour for an HOURLY rule, etc. For example, within a DAILY rule, a value of "8" means every eight days.
BYSECOND The BYSECOND rule part specifies a COMMA-separated list of seconds within a minute. Valid values are 0 to 60.
BYMINUTE The BYMINUTE rule part specifies a COMMA-separated list of minutes within an hour. Valid values are 0 to 59.
BYHOUR The BYHOUR rule part specifies a COMMA-separated list of hours of the day. Valid values are 0 to 23.
BYDAY The BYDAY rule part specifies a COMMA-separated list of days of the week; SU indicates Sunday; MO indicates Monday; TU indicates Tuesday; WE indicates Wednesday; TH indicates Thursday; FR indicates Friday; and SA indicates Saturday. Each BYDAY value can also be preceded by a positive (+n) or negative (-n) integer. If present, this indicates the nth occurrence of a specific day within the MONTHLY or YEARLY recurrence_rule.
BYMONTHDAY The BYMONTHDAY rule part specifies a COMMA-separated list of days of the month. Valid values are 1 to 31 or -31 to -1. For example, -10 represents the tenth to the last day of the month. The BYMONTHDAY rule part MUST NOT be specified when the FREQ rule part is set to WEEKLY.
BYYEARDAY The BYYEARDAY rule part specifies a COMMA-separated list of days of the year. Valid values are 1 to 366 or -366 to -1. For example, -1 represents the last day of the year (December 31st) and -306 represents the 306th to the last day of the year (March 1st). The BYYEARDAY rule part MUST NOT be specified when the FREQ rule part is set to DAILY, WEEKLY, or MONTHLY.
BYWEEKNO The BYWEEKNO rule part specifies a COMMA-separated list of ordinals specifying weeks of the year. Valid values are 1 to 53 or -53 to -1. This corresponds to weeks according to week numbering as defined in ISO.8601.2004. A week is defined as a seven day period, starting on the day of the week defined to be the week start (see WKST). Week number one of the calendar year is the first week that contains at least four (4) days in that calendar year. This rule part MUST NOT be used when the FREQ rule part is set to anything other than YEARLY. For example, 3 represents the third week of the year.
BYMONTH The BYMONTH rule part specifies a COMMA-separated list of months of the year. Valid values are 1 to 12.
WKST Specifies the day on which the workweek starts. Valid values are MO, TU, WE, TH, FR, SA, and SU. This is significant when a WEEKLY recurrence_rule has an interval greater than 1, and a BYDAY rule part is specified. This is also significant when in a YEARLY recurrence_rule when a BYWEEKNO rule part is specified. The default value is MO.
BYSETPOSThe BYSETPOS rule part specifies a COMMA-separated list of values that corresponds to the nth occurrence within the set of recurrence instances specified by the rule. BYSETPOS operates on a set of recurrence instances in one interval of the recurrence rule. For example, in a WEEKLY rule, the interval would be one week A set of recurrence instances starts at the beginning of the interval defined by the FREQ rule part. Valid values are 1 to 366 or -366 to -1. It MUST only be used in conjunction with another BYxxx rule part. For example "the last work day of the month" could be represented as: FREQ=MONTHLY;BYDAY=MO,TU,WE,TH,FR;BYSETPOS=-1. Each BYSETPOS value can include a positive (+n) or negative (-n) integer. If present, this indicates the nth occurrence of the specific occurrence within the set of occurrences specified by the rule.

Note: The BYSECOND, BYMINUTE and BYHOUR rule parts MUST NOT be specified when the associated start_date property is specified.

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.

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_calendar_event, and is also used when creating an event to be added using the put_calendar_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_encoded Property

This is 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

This is 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_encoded Property

This is 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

This is 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_cert_store Property

This is 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

This is 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 are designations of the most common User and Machine certificate stores in Windows:

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot certificates.

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 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

This is 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

This is 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:

0 (cstUser - default)For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: this store type is not available in Java.
1 (cstMachine)For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java.
2 (cstPFXFile)The certificate store is the name of a PFX (PKCS12) file containing certificates.
3 (cstPFXBlob)The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) format.
4 (cstJKSFile)The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: this store type is only available in Java.
5 (cstJKSBlob)The certificate store is a string (binary or base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: this store type is only available in Java.
6 (cstPEMKeyFile)The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)The certificate store is a string (binary or base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)The certificate store is a string (binary or base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)The certificate store is a string (binary or base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)The certificate store is the name of a PKCS7 file containing certificates.
12 (cstP7BBlob)The certificate store is a string (binary) representing a certificate store in PKCS7 format.
13 (cstSSHPublicKeyFile)The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)The certificate store is a string that contains a JWK (JSON Web Key).
20 (cstSecurityKey)The certificate is present on a physical security key accessible via a PKCS11 interface.

To use a security key the necessary data must first be collected using the CertMgr class. The list_store_certificates method may be called after setting cert_store_type to cstSecurityKey, cert_store_password to the PIN, and cert_store to the full path of the PKCS11 dll. The certificate information returned in the on_cert_list event's CertEncoded parameter may be saved for later use.

When using a certificate, pass the previously saved security key information as the ssl_cert_store and set ssl_cert_store_password to the PIN.

Code Example: SSH Authentication with Security Key certmgr.CertStoreType = CertStoreTypes.cstSecurityKey; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstSecurityKey, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);

21 (cstBCFKSFile)The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). Note: this store type is only available in Java and .NET.
22 (cstBCFKSBlob)The certificate store is a string (binary or base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. Note: this store type is only available in Java and .NET.
99 (cstAuto)The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

ssl_cert_subject Property

This is 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

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properites are set. When this property is set, a search is performed in the current certificate store certificate with 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 displayed below.

FieldMeaning
CNCommon Name. This is commonly a host name like www.server.com.
OOrganization
OUOrganizational Unit
LLocality
SState
CCountry
EEmail Address

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

ssl_provider Property

This specifies the 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:

0 (sslpAutomatic - default)Automatically selects the appropriate implementation.
1 (sslpPlatform) Uses the platform/system implementation.
2 (sslpInternal) Uses the internal implementation.

Additional Notes

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_encoded Property

This is 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

This is 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_calendar_event, and is also used when creating an event to be added using the put_calendar_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:

TENTATIVEIndicates event is tentative.
CONFIRMEDIndicates event is definite.
CANCELLEDIndicates event was canceled.

Statuses for a vTodo event_type:

NEEDS-ACTIONIndicates to-do needs action.
COMPLETEDIndicates to-do completed.
IN-PROCESSIndicates to-do in process of.
CANCELLEDIndicates to-do was canceled.

Statuses for a vJournal event_type:

DRAFTIndicates event is draft.
FINALIndicates event is final.
CANCELLEDIndicates event is removed.

This property is filled from the response to a get_calendar_event, and is also used when creating an event to be added using the put_calendar_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_line Property

This property is the first line of the last server response.

Syntax

def get_status_line() -> str: ...

status_line = property(get_status_line, None)

Default Value

""

Remarks

This property contains the first line of the last server response. This value can be used for diagnostic purposes. If an HTTP error is returned when calling a method of the class, the error string is the same as the status_line property.

The HTTP protocol specifies the structure of the status_line as follows: [HTTP version] [Result Code] [Description].

This property is read-only.

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_calendar_event, and is also used when creating an event to be added using the put_calendar_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

A 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.

Please note that by default, all timeouts are inactivity timeouts, i.e. 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_calendar_event, and is also used when creating an event to be added using the put_calendar_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:

FREQFrequency of the time zone onset. (Almost always "YEARLY")
BYMONTHThe month of the time zone onset.
BYDAYThe day of the time zone onset. Formatted as a number and a two-character day. "BYDAY=3SU" means the 3rd Sunday of the month. "BYDAY=-1SU" is the last Sunday of the month.
UNTILIf the observance is known to have an effective end date, the "UNTIL" recurrence rule parameter MUST be used to specify the last valid onset of this observance (i.e., the UNTIL DATE-TIME will be equal to the last instance generated by the recurrence pattern). It MUST be specified in UTC time.

Note that the timezone_dst_start and timezone_dst_offset_from properties must be used when generating the onset DATE-TIME values (instances) from the timezone_dst_rule

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:

FREQFrequency of the time zone onset. (Almost always "YEARLY")
BYMONTHThe month of the time zone onset.
BYDAYThe day of the time zone onset. Formatted as a number and a two-character day. "BYDAY=3SU" means the 3rd Sunday of the month. "BYDAY=-1SU" is the last Sunday of the month.
UNTILIf the observance is known to have an effective end date, the "UNTIL" recurrence rule parameter MUST be used to specify the last valid onset of this observance (i.e., the UNTIL DATE-TIME will be equal to the last instance generated by the recurrence pattern). It MUST be specified in UTC time.

Note that the timezone_std_start and timezone_std_offset_from properties must be used when generating the onset DATE-TIME values (instances) from the timezone_std_rule

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_calendar_event, and is also used when creating an event to be added using the put_calendar_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 put_calendar_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_calendar_event, and is also used when creating an event to be added using the put_calendar_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_calendar_event, and is also used when creating an event to be added using the put_calendar_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

This 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 property 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:

CalDAVControl.Reset() CalDAVControl.AddCustomProperty("propname1", "propvalue1") CalDAVControl.AddCustomProperty("propname2", "propvalue2") Example using Custom Property arrays: CalDAVControl.Reset() CalDAVControl.CustomPropertyCount = 2 CalDAVControl.CustomPropertyName (0) = "propname1" CalDAVControl.CustomPropertyValue(0) = "propvalue1" CalDAVControl.CustomPropertyName (1) = "propname2" CalDAVControl.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_calendar_event Method

Copy events to a new location.

Syntax

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

Remarks

The copy_calendar_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://www.google.com/calendar/dav/" plus your email address to access the default calendar. So "https://www.google.com/calendar/dav/username@gmail.com/" is the base URI for the default calendar. If you have multiple calendars, replace the email address portion above with the Id of the calendar, plus "@group.calendar.google.com/". For instance: "https://www.google.com/calendar/dav/ev3nkr4ua83jej7q32oumn5eeo@group.calendar.google.com/". For Google, calendar events are stored in the "/events/" path. To retrieve a report on a calendar, you'd add "/events/" to one of the above paths. For example: CalDAV.GetCalendarReport("https://www.google.com/calendar/dav/username@gmail.com/events/"); Leaving the "/events/" out of the URI will result in an HTTP protocol error: 405 Method not allowed.

To add or retrieve an event, add the UID of the event you're creating or retrieving plus ".ics" to the path. Note that when putting an event with the put_calendar_event method, if the resourceURI and the UID do not match Google will create the event using the UID stored in the uid property. The actual location of will be newly added event will be returned in a "Location" header. This is the resource URI you must use to retrieve the event with get_calendar_event. For example: CalDAV.UID = "1234567890"; CalDAV.PutCalendarEvent("https://www.google.com/calendar/dav/username@gmail.com/events/1234567890.ics");

Yahoo uses a different format for CalDAV access. Yahoo's ResourceURIs always start with "https://caldav.calendar.yahoo.com/dav/" plus your user name, plus "/Calendar/" plus the name of your calendar. For instance: "https://caldav.calendar.yahoo.com/dav/username/Calendar/Your_Name" for the default calendar. (Yahoo uses your name to create the default calendar). When using the create_calendar event to create a new calendar, replace "Your_Name" in the URI with the desired name of your new calendar. Event resources are located directly under the "/Calendar/Calendar_Name/" path. Like Google, the UID and filename portion of the resource URI must match, but Yahoo will actually return an HTTP protocol error if they differ. The examples below show a few possible transactions: CalDAVS1.User = "username"; CalDAVS1.Password = "password"; CalDAV.DisplayName = "My Hockey Calendar"; CalDAV.CreateCalendar("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/"); CalDAV.StartDate = "20100401T040000"; CalDAV.EndDate = "20100401T060000"; CalDAV.UID = "qwerty1234567"; CalDAV.Summary = "First Practice"; CalDAV.Location = "Rink on 1st and main"; CalDAV.EventType = vEvent; CalDAV.PutCalendarEvent("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/qwerty1234567.ics"); CalDAV.GetCalendarReport("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/");

create_calendar Method

Creates a new calendar collection resource.

Syntax

def create_calendar(resource_uri: 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 following properties are used to create a new calendar collection resource:

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. CalDAVS1.DisplayName = "Testing Create Calendar method"; CalDAVS1.Description = "Test Calendar"; CalDAVS1.CreateCalendar("https://caldav.calendar.yahoo.com/dav/userid/Calendar/TestCal1");

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://www.google.com/calendar/dav/" plus your email address to access the default calendar. So "https://www.google.com/calendar/dav/username@gmail.com/" is the base URI for the default calendar. If you have multiple calendars, replace the email address portion above with the Id of the calendar, plus "@group.calendar.google.com/". For instance: "https://www.google.com/calendar/dav/ev3nkr4ua83jej7q32oumn5eeo@group.calendar.google.com/". For Google, calendar events are stored in the "/events/" path. To retrieve a report on a calendar, you'd add "/events/" to one of the above paths. For example: CalDAV.GetCalendarReport("https://www.google.com/calendar/dav/username@gmail.com/events/"); Leaving the "/events/" out of the URI will result in an HTTP protocol error: 405 Method not allowed.

To add or retrieve an event, add the UID of the event you're creating or retrieving plus ".ics" to the path. Note that when putting an event with the put_calendar_event method, if the resourceURI and the UID do not match Google will create the event using the UID stored in the uid property. The actual location of will be newly added event will be returned in a "Location" header. This is the resource URI you must use to retrieve the event with get_calendar_event. For example: CalDAV.UID = "1234567890"; CalDAV.PutCalendarEvent("https://www.google.com/calendar/dav/username@gmail.com/events/1234567890.ics");

Yahoo uses a different format for CalDAV access. Yahoo's ResourceURIs always start with "https://caldav.calendar.yahoo.com/dav/" plus your user name, plus "/Calendar/" plus the name of your calendar. For instance: "https://caldav.calendar.yahoo.com/dav/username/Calendar/Your_Name" for the default calendar. (Yahoo uses your name to create the default calendar). When using the create_calendar event to create a new calendar, replace "Your_Name" in the URI with the desired name of your new calendar. Event resources are located directly under the "/Calendar/Calendar_Name/" path. Like Google, the UID and filename portion of the resource URI must match, but Yahoo will actually return an HTTP protocol error if they differ. The examples below show a few possible transactions: CalDAVS1.User = "username"; CalDAVS1.Password = "password"; CalDAV.DisplayName = "My Hockey Calendar"; CalDAV.CreateCalendar("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/"); CalDAV.StartDate = "20100401T040000"; CalDAV.EndDate = "20100401T060000"; CalDAV.UID = "qwerty1234567"; CalDAV.Summary = "First Practice"; CalDAV.Location = "Rink on 1st and main"; CalDAV.EventType = vEvent; CalDAV.PutCalendarEvent("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/qwerty1234567.ics"); CalDAV.GetCalendarReport("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/");

delete_calendar_event Method

Delete a resource or collection.

Syntax

def delete_calendar_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://www.google.com/calendar/dav/" plus your email address to access the default calendar. So "https://www.google.com/calendar/dav/username@gmail.com/" is the base URI for the default calendar. If you have multiple calendars, replace the email address portion above with the Id of the calendar, plus "@group.calendar.google.com/". For instance: "https://www.google.com/calendar/dav/ev3nkr4ua83jej7q32oumn5eeo@group.calendar.google.com/". For Google, calendar events are stored in the "/events/" path. To retrieve a report on a calendar, you'd add "/events/" to one of the above paths. For example: CalDAV.GetCalendarReport("https://www.google.com/calendar/dav/username@gmail.com/events/"); Leaving the "/events/" out of the URI will result in an HTTP protocol error: 405 Method not allowed.

To add or retrieve an event, add the UID of the event you're creating or retrieving plus ".ics" to the path. Note that when putting an event with the put_calendar_event method, if the resourceURI and the UID do not match Google will create the event using the UID stored in the uid property. The actual location of will be newly added event will be returned in a "Location" header. This is the resource URI you must use to retrieve the event with get_calendar_event. For example: CalDAV.UID = "1234567890"; CalDAV.PutCalendarEvent("https://www.google.com/calendar/dav/username@gmail.com/events/1234567890.ics");

Yahoo uses a different format for CalDAV access. Yahoo's ResourceURIs always start with "https://caldav.calendar.yahoo.com/dav/" plus your user name, plus "/Calendar/" plus the name of your calendar. For instance: "https://caldav.calendar.yahoo.com/dav/username/Calendar/Your_Name" for the default calendar. (Yahoo uses your name to create the default calendar). When using the create_calendar event to create a new calendar, replace "Your_Name" in the URI with the desired name of your new calendar. Event resources are located directly under the "/Calendar/Calendar_Name/" path. Like Google, the UID and filename portion of the resource URI must match, but Yahoo will actually return an HTTP protocol error if they differ. The examples below show a few possible transactions: CalDAVS1.User = "username"; CalDAVS1.Password = "password"; CalDAV.DisplayName = "My Hockey Calendar"; CalDAV.CreateCalendar("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/"); CalDAV.StartDate = "20100401T040000"; CalDAV.EndDate = "20100401T060000"; CalDAV.UID = "qwerty1234567"; CalDAV.Summary = "First Practice"; CalDAV.Location = "Rink on 1st and main"; CalDAV.EventType = vEvent; CalDAV.PutCalendarEvent("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/qwerty1234567.ics"); CalDAV.GetCalendarReport("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/");

do_events 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 put_calendar_event method sends when adding or updating an event to a calendar.

Note that if export_ics is called immediately after a successful get_calendar_event, the unmodified calendar returned from the CalDAV server will be returned. However if any properties are changed between the get_calendar_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 put_calendar_event or export_ics, and will be filled after calling get_calendar_event or import_ics. These will also be available from inside the on_event_details event, which is fired for each event received from the CalDAV server in response to a get_calendar_report.

get_calendar_event Method

Retrieves a single event from the CalDAV server.

Syntax

def get_calendar_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 fetched 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 put_calendar_event to update the calendar event resource.

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

There is no standard format for resource URIs. Google for instance, uses "https://www.google.com/calendar/dav/" plus your email address to access the default calendar. So "https://www.google.com/calendar/dav/username@gmail.com/" is the base URI for the default calendar. If you have multiple calendars, replace the email address portion above with the Id of the calendar, plus "@group.calendar.google.com/". For instance: "https://www.google.com/calendar/dav/ev3nkr4ua83jej7q32oumn5eeo@group.calendar.google.com/". For Google, calendar events are stored in the "/events/" path. To retrieve a report on a calendar, you'd add "/events/" to one of the above paths. For example: CalDAV.GetCalendarReport("https://www.google.com/calendar/dav/username@gmail.com/events/"); Leaving the "/events/" out of the URI will result in an HTTP protocol error: 405 Method not allowed.

To add or retrieve an event, add the UID of the event you're creating or retrieving plus ".ics" to the path. Note that when putting an event with the put_calendar_event method, if the resourceURI and the UID do not match Google will create the event using the UID stored in the uid property. The actual location of will be newly added event will be returned in a "Location" header. This is the resource URI you must use to retrieve the event with get_calendar_event. For example: CalDAV.UID = "1234567890"; CalDAV.PutCalendarEvent("https://www.google.com/calendar/dav/username@gmail.com/events/1234567890.ics");

Yahoo uses a different format for CalDAV access. Yahoo's ResourceURIs always start with "https://caldav.calendar.yahoo.com/dav/" plus your user name, plus "/Calendar/" plus the name of your calendar. For instance: "https://caldav.calendar.yahoo.com/dav/username/Calendar/Your_Name" for the default calendar. (Yahoo uses your name to create the default calendar). When using the create_calendar event to create a new calendar, replace "Your_Name" in the URI with the desired name of your new calendar. Event resources are located directly under the "/Calendar/Calendar_Name/" path. Like Google, the UID and filename portion of the resource URI must match, but Yahoo will actually return an HTTP protocol error if they differ. The examples below show a few possible transactions: CalDAVS1.User = "username"; CalDAVS1.Password = "password"; CalDAV.DisplayName = "My Hockey Calendar"; CalDAV.CreateCalendar("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/"); CalDAV.StartDate = "20100401T040000"; CalDAV.EndDate = "20100401T060000"; CalDAV.UID = "qwerty1234567"; CalDAV.Summary = "First Practice"; CalDAV.Location = "Rink on 1st and main"; CalDAV.EventType = vEvent; CalDAV.PutCalendarEvent("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/qwerty1234567.ics"); CalDAV.GetCalendarReport("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/");

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:

FieldValue
Allow OPTIONS, GET, HEAD, POST, PUT, DELETE, TRACE, COPY, MOVE
Allow PROPFIND, PROPPATCH, LOCK, UNLOCK, REPORT, ACL
DAV 1, 2, access-control, calendar-access
Date Sat, 11 Nov 2006 09:32:12 GMT
Content-Length0

Since the "DAV" header contains "calendar-access", CalDAV is supported on this ResourceURI.

There is no standard format for resource URIs. Google for instance, uses "https://www.google.com/calendar/dav/" plus your email address to access the default calendar. So "https://www.google.com/calendar/dav/username@gmail.com/" is the base URI for the default calendar. If you have multiple calendars, replace the email address portion above with the Id of the calendar, plus "@group.calendar.google.com/". For instance: "https://www.google.com/calendar/dav/ev3nkr4ua83jej7q32oumn5eeo@group.calendar.google.com/". For Google, calendar events are stored in the "/events/" path. To retrieve a report on a calendar, you'd add "/events/" to one of the above paths. For example: CalDAV.GetCalendarReport("https://www.google.com/calendar/dav/username@gmail.com/events/"); Leaving the "/events/" out of the URI will result in an HTTP protocol error: 405 Method not allowed.

To add or retrieve an event, add the UID of the event you're creating or retrieving plus ".ics" to the path. Note that when putting an event with the put_calendar_event method, if the resourceURI and the UID do not match Google will create the event using the UID stored in the uid property. The actual location of will be newly added event will be returned in a "Location" header. This is the resource URI you must use to retrieve the event with get_calendar_event. For example: CalDAV.UID = "1234567890"; CalDAV.PutCalendarEvent("https://www.google.com/calendar/dav/username@gmail.com/events/1234567890.ics");

Yahoo uses a different format for CalDAV access. Yahoo's ResourceURIs always start with "https://caldav.calendar.yahoo.com/dav/" plus your user name, plus "/Calendar/" plus the name of your calendar. For instance: "https://caldav.calendar.yahoo.com/dav/username/Calendar/Your_Name" for the default calendar. (Yahoo uses your name to create the default calendar). When using the create_calendar event to create a new calendar, replace "Your_Name" in the URI with the desired name of your new calendar. Event resources are located directly under the "/Calendar/Calendar_Name/" path. Like Google, the UID and filename portion of the resource URI must match, but Yahoo will actually return an HTTP protocol error if they differ. The examples below show a few possible transactions: CalDAVS1.User = "username"; CalDAVS1.Password = "password"; CalDAV.DisplayName = "My Hockey Calendar"; CalDAV.CreateCalendar("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/"); CalDAV.StartDate = "20100401T040000"; CalDAV.EndDate = "20100401T060000"; CalDAV.UID = "qwerty1234567"; CalDAV.Summary = "First Practice"; CalDAV.Location = "Rink on 1st and main"; CalDAV.EventType = vEvent; CalDAV.PutCalendarEvent("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/qwerty1234567.ics"); CalDAV.GetCalendarReport("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/");

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 put_calendar_event or export_ics, and will be filled after calling get_calendar_event or import_ics. These will also be available from inside the on_event_details event, which is fired for each event received from the CalDAV server in response to a get_calendar_report.

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, STATUS As String, ETag As String, CalendarData As String) Debug.Print CalDAV.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://www.google.com/calendar/dav/" plus your email address to access the default calendar. So "https://www.google.com/calendar/dav/username@gmail.com/" is the base URI for the default calendar. If you have multiple calendars, replace the email address portion above with the Id of the calendar, plus "@group.calendar.google.com/". For instance: "https://www.google.com/calendar/dav/ev3nkr4ua83jej7q32oumn5eeo@group.calendar.google.com/". For Google, calendar events are stored in the "/events/" path. To retrieve a report on a calendar, you'd add "/events/" to one of the above paths. For example: CalDAV.GetCalendarReport("https://www.google.com/calendar/dav/username@gmail.com/events/"); Leaving the "/events/" out of the URI will result in an HTTP protocol error: 405 Method not allowed.

To add or retrieve an event, add the UID of the event you're creating or retrieving plus ".ics" to the path. Note that when putting an event with the put_calendar_event method, if the resourceURI and the UID do not match Google will create the event using the UID stored in the uid property. The actual location of will be newly added event will be returned in a "Location" header. This is the resource URI you must use to retrieve the event with get_calendar_event. For example: CalDAV.UID = "1234567890"; CalDAV.PutCalendarEvent("https://www.google.com/calendar/dav/username@gmail.com/events/1234567890.ics");

Yahoo uses a different format for CalDAV access. Yahoo's ResourceURIs always start with "https://caldav.calendar.yahoo.com/dav/" plus your user name, plus "/Calendar/" plus the name of your calendar. For instance: "https://caldav.calendar.yahoo.com/dav/username/Calendar/Your_Name" for the default calendar. (Yahoo uses your name to create the default calendar). When using the create_calendar event to create a new calendar, replace "Your_Name" in the URI with the desired name of your new calendar. Event resources are located directly under the "/Calendar/Calendar_Name/" path. Like Google, the UID and filename portion of the resource URI must match, but Yahoo will actually return an HTTP protocol error if they differ. The examples below show a few possible transactions: CalDAVS1.User = "username"; CalDAVS1.Password = "password"; CalDAV.DisplayName = "My Hockey Calendar"; CalDAV.CreateCalendar("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/"); CalDAV.StartDate = "20100401T040000"; CalDAV.EndDate = "20100401T060000"; CalDAV.UID = "qwerty1234567"; CalDAV.Summary = "First Practice"; CalDAV.Location = "Rink on 1st and main"; CalDAV.EventType = vEvent; CalDAV.PutCalendarEvent("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/qwerty1234567.ics"); CalDAV.GetCalendarReport("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/");

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://www.google.com/calendar/dav/" plus your email address to access the default calendar. So "https://www.google.com/calendar/dav/username@gmail.com/" is the base URI for the default calendar. If you have multiple calendars, replace the email address portion above with the Id of the calendar, plus "@group.calendar.google.com/". For instance: "https://www.google.com/calendar/dav/ev3nkr4ua83jej7q32oumn5eeo@group.calendar.google.com/". For Google, calendar events are stored in the "/events/" path. To retrieve a report on a calendar, you'd add "/events/" to one of the above paths. For example: CalDAV.GetCalendarReport("https://www.google.com/calendar/dav/username@gmail.com/events/"); Leaving the "/events/" out of the URI will result in an HTTP protocol error: 405 Method not allowed.

To add or retrieve an event, add the UID of the event you're creating or retrieving plus ".ics" to the path. Note that when putting an event with the put_calendar_event method, if the resourceURI and the UID do not match Google will create the event using the UID stored in the uid property. The actual location of will be newly added event will be returned in a "Location" header. This is the resource URI you must use to retrieve the event with get_calendar_event. For example: CalDAV.UID = "1234567890"; CalDAV.PutCalendarEvent("https://www.google.com/calendar/dav/username@gmail.com/events/1234567890.ics");

Yahoo uses a different format for CalDAV access. Yahoo's ResourceURIs always start with "https://caldav.calendar.yahoo.com/dav/" plus your user name, plus "/Calendar/" plus the name of your calendar. For instance: "https://caldav.calendar.yahoo.com/dav/username/Calendar/Your_Name" for the default calendar. (Yahoo uses your name to create the default calendar). When using the create_calendar event to create a new calendar, replace "Your_Name" in the URI with the desired name of your new calendar. Event resources are located directly under the "/Calendar/Calendar_Name/" path. Like Google, the UID and filename portion of the resource URI must match, but Yahoo will actually return an HTTP protocol error if they differ. The examples below show a few possible transactions: CalDAVS1.User = "username"; CalDAVS1.Password = "password"; CalDAV.DisplayName = "My Hockey Calendar"; CalDAV.CreateCalendar("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/"); CalDAV.StartDate = "20100401T040000"; CalDAV.EndDate = "20100401T060000"; CalDAV.UID = "qwerty1234567"; CalDAV.Summary = "First Practice"; CalDAV.Location = "Rink on 1st and main"; CalDAV.EventType = vEvent; CalDAV.PutCalendarEvent("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/qwerty1234567.ics"); CalDAV.GetCalendarReport("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/");

import_ics Method

Imports iCal 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 put_calendar_event. If you edit any of the class properties between importing and calling put_calendar_event, the class will re-generate the PUT request itself. If no properties are changed, the imported data will be submitted unaltered when calling put_calendar_event.

Note that the CalendarData you wish to import must contain a single VEVENT, VTODO, or VJOURNAL inside of a VCALENDAR. (A VTIMEZONE may be optionally contained inside the VCALENDAR as well). If multiple calendar objects are included in the imported data they will not be parsed correctly into properties, and the server's response to the put_calendar_event method is undefined.

interrupt Method

Interrupt the current method.

Syntax

def interrupt() -> None: ...

Remarks

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

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:

lock_ownerThe principle that will own the lock.
lock_scopeThe scope of the lock. The class only currently supports locks of scope "exclusive" and "shared".
lock_timeoutThe amount of time that the lock is allowed to exist before ResourceURI is automatically unlocked by the server.
lock_tokensThe lock itself. If the user sets this before making the request, the timeout on the existing lock will be refreshed (reset to 0). Otherwise, a new set of lock tokens will be returned.
lock_typeThe type of lock. The class only currently supports of type "write".

After a successful call to the lock_calendar method the class will receive the new lock values, which it will parse and store in the lock properties.

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_calendar_event or copy_calendar_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_calendar_event Method

Moves one calendar resource to a new location.

Syntax

def move_calendar_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://www.google.com/calendar/dav/" plus your email address to access the default calendar. So "https://www.google.com/calendar/dav/username@gmail.com/" is the base URI for the default calendar. If you have multiple calendars, replace the email address portion above with the Id of the calendar, plus "@group.calendar.google.com/". For instance: "https://www.google.com/calendar/dav/ev3nkr4ua83jej7q32oumn5eeo@group.calendar.google.com/". For Google, calendar events are stored in the "/events/" path. To retrieve a report on a calendar, you'd add "/events/" to one of the above paths. For example: CalDAV.GetCalendarReport("https://www.google.com/calendar/dav/username@gmail.com/events/"); Leaving the "/events/" out of the URI will result in an HTTP protocol error: 405 Method not allowed.

To add or retrieve an event, add the UID of the event you're creating or retrieving plus ".ics" to the path. Note that when putting an event with the put_calendar_event method, if the resourceURI and the UID do not match Google will create the event using the UID stored in the uid property. The actual location of will be newly added event will be returned in a "Location" header. This is the resource URI you must use to retrieve the event with get_calendar_event. For example: CalDAV.UID = "1234567890"; CalDAV.PutCalendarEvent("https://www.google.com/calendar/dav/username@gmail.com/events/1234567890.ics");

Yahoo uses a different format for CalDAV access. Yahoo's ResourceURIs always start with "https://caldav.calendar.yahoo.com/dav/" plus your user name, plus "/Calendar/" plus the name of your calendar. For instance: "https://caldav.calendar.yahoo.com/dav/username/Calendar/Your_Name" for the default calendar. (Yahoo uses your name to create the default calendar). When using the create_calendar event to create a new calendar, replace "Your_Name" in the URI with the desired name of your new calendar. Event resources are located directly under the "/Calendar/Calendar_Name/" path. Like Google, the UID and filename portion of the resource URI must match, but Yahoo will actually return an HTTP protocol error if they differ. The examples below show a few possible transactions: CalDAVS1.User = "username"; CalDAVS1.Password = "password"; CalDAV.DisplayName = "My Hockey Calendar"; CalDAV.CreateCalendar("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/"); CalDAV.StartDate = "20100401T040000"; CalDAV.EndDate = "20100401T060000"; CalDAV.UID = "qwerty1234567"; CalDAV.Summary = "First Practice"; CalDAV.Location = "Rink on 1st and main"; CalDAV.EventType = vEvent; CalDAV.PutCalendarEvent("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/qwerty1234567.ics"); CalDAV.GetCalendarReport("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/");

put_calendar_event Method

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

Syntax

def put_calendar_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 put_calendar_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 put_calendar_event or export_ics, and will be filled after calling get_calendar_event or import_ics. These will also be available from inside the on_event_details event, which is fired for each event received from the CalDAV server in response to a get_calendar_report.

There is no standard format for resource URIs. Google for instance, uses "https://www.google.com/calendar/dav/" plus your email address to access the default calendar. So "https://www.google.com/calendar/dav/username@gmail.com/" is the base URI for the default calendar. If you have multiple calendars, replace the email address portion above with the Id of the calendar, plus "@group.calendar.google.com/". For instance: "https://www.google.com/calendar/dav/ev3nkr4ua83jej7q32oumn5eeo@group.calendar.google.com/". For Google, calendar events are stored in the "/events/" path. To retrieve a report on a calendar, you'd add "/events/" to one of the above paths. For example: CalDAV.GetCalendarReport("https://www.google.com/calendar/dav/username@gmail.com/events/"); Leaving the "/events/" out of the URI will result in an HTTP protocol error: 405 Method not allowed.

To add or retrieve an event, add the UID of the event you're creating or retrieving plus ".ics" to the path. Note that when putting an event with the put_calendar_event method, if the resourceURI and the UID do not match Google will create the event using the UID stored in the uid property. The actual location of will be newly added event will be returned in a "Location" header. This is the resource URI you must use to retrieve the event with get_calendar_event. For example: CalDAV.UID = "1234567890"; CalDAV.PutCalendarEvent("https://www.google.com/calendar/dav/username@gmail.com/events/1234567890.ics");

Yahoo uses a different format for CalDAV access. Yahoo's ResourceURIs always start with "https://caldav.calendar.yahoo.com/dav/" plus your user name, plus "/Calendar/" plus the name of your calendar. For instance: "https://caldav.calendar.yahoo.com/dav/username/Calendar/Your_Name" for the default calendar. (Yahoo uses your name to create the default calendar). When using the create_calendar event to create a new calendar, replace "Your_Name" in the URI with the desired name of your new calendar. Event resources are located directly under the "/Calendar/Calendar_Name/" path. Like Google, the UID and filename portion of the resource URI must match, but Yahoo will actually return an HTTP protocol error if they differ. The examples below show a few possible transactions: CalDAVS1.User = "username"; CalDAVS1.Password = "password"; CalDAV.DisplayName = "My Hockey Calendar"; CalDAV.CreateCalendar("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/"); CalDAV.StartDate = "20100401T040000"; CalDAV.EndDate = "20100401T060000"; CalDAV.UID = "qwerty1234567"; CalDAV.Summary = "First Practice"; CalDAV.Location = "Rink on 1st and main"; CalDAV.EventType = vEvent; CalDAV.PutCalendarEvent("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/qwerty1234567.ics"); CalDAV.GetCalendarReport("https://caldav.calendar.yahoo.com/dav/username/Calendar/Hockey_Calendar/");

reset Method

Reset the class.

Syntax

def reset() -> None: ...

Remarks

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

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_tokens property must be set to the lock tokens for ResourceURI. The method will remove the lock, allowing other users or non-privileged users to access and operate on the file.

on_connected Event

This event is 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

This event is 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

The on_connection_status 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:

Firewall connection complete.
Secure Sockets Layer (SSL) or S/Shell handshake complete (where applicable).
Remote host connection complete.
Remote host disconnected.
SSL or S/Shell connection broken.
Firewall host disconnected.

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.

on_disconnected Event

This event is 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

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

Information 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.

ErrorCode contains an error code and Description 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: ...

# 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.

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

This event is 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

This event fires 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 fires 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:

0 (None) No events are logged.
1 (Info - default) Informational events are logged.
2 (Verbose) Detailed data are logged.
3 (Debug) Debug data are logged.

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

This event is 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

This event is 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

The on_set_cookie 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

This event is where the client can decide whether to continue with the connection process or not. 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 to continue or not.

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

Shows the progress of the secure connection.

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. Used to track the progress of the connection.

on_start_transfer Event

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

This event is 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

This event is 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

The class accepts one or more of the following configuration settings. Configuration 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.

CalDAV Config Settings

AuthScheme:   The authentication scheme to use for server authorization.

This setting is used to support non-standard CalDAV server authentication. The following values are supported:

0Basic
1Digest
2Proprietary
3None
4NTLM

Use the AuthScheme setting to tell the class which type of authorization to perform when the user and password properties are set. By default, CalDav servers use Basic authentication, and if the user and password properties are set, the class will attempt basic authentication. Digest, NTLM, and Negotiate authentication are also available to support custom CalDAV server implementations.

Note that if the AuthScheme is set to Proprietary (2) then the authorization token must be supplied through Authorization setting.

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

BuildEvent:   Builds the current event for a multi-event calendar entry.

Calling this setting signals the component to build the current event for a multi-event calendar entry (typically a recurring event with one or more 'exception' events).

Note: this setting is used in conjunction with StartCalendar and EndCalendar.

EndCalendar:   Signifies the end of a multi-event calendar entry.

This setting signifies the end of a multi-event calendar entry (typically a recurring event with one or more 'exception' events). Calling this setting returns the data for the calendar, which can then be imported using the import_ics method.

Note: this setting is used in conjunction with BuildEvent and StartCalendar.

ExpandRecurringEvents:   Instructs the component to return all instances of a recurring event within a timeframe.

When false (default), the CalDAV server will return only a single response for each recurring event along with the recurrence rules. If this configuration option is set to true the CalDAV server will return a response for each instance of a recurring event during a given time interval. The report_filter.RecurStart and report_filter.RecurEnd fields must also be set to use this functionality. Please see the example code below: calDAV.ReportFilter.StartDate = "20120130T000000Z"; calDAV.ReportFilter.EndDate = "20120203T235959Z"; calDAV.ReportFilter.RecurStart = calDAV.ReportFilter.StartDate; calDAV.ReportFilter.RecurEnd = calDAV.ReportFilter.EndDate; calDAV.Config("ExpandRecurringEvents=true"); calDAV.ReportFilter.ReturnCalendarData = true; calDAV.ReportFilter.EventType = VEventTypes.vtAll; calDAV.GetCalendarReport("http://www.some-url.com/caldav.php/events");

ProductId:   Specifies the identifier for the product that created the iCalendar object.

The vendor of the implementation should assure that this is a globally unique identifier.

This setting should not be used to alter the interpretation of a calendar resource. For example, it is not to be used to further the understanding of non-standard properties.

This setting is required to have a value when creating a new calendar collection resource via the create_calendar method. For all others it is optional.

RecurrenceExceptionDatesAttrs:   Specifies the attributes for the exception dates of a recurring event.

This setting specifies the attributes for the exception dates of a recurring event. The setting should be populated with a COMMA-separated list of one or more attributes, where each attribute is applied to the corresponding date listed in the RecurrenceExceptionDates property.

The table below shows some examples of supported values.

VALUE=DATE,VALUE=DATE Attributes for the FIRST and SECOND exception dates.
VALUE=DATE,Attribute for the FIRST exception date.
,VALUE=DATEAttribute for the SECOND exception date.

StartCalendar:   Signifies the beginning of a multi-event calendar entry.

This setting signifies the beginning of a multi-event calendar entry (typically a recurring event with one or more 'exception' events).

Note: this setting is used in conjunction with BuildEvent and EndCalendar.

WebDAV Config Settings

EncodeURL:   If set to true the URL will be encoded by the class.

The default value is false. If set to true the URL passed to the class will be URL encoded.

IsDir[i]:   Whether or not the resource at the specified index is a directory.

After calling list_directory, this config can be queried to determine whether or not the resource at index i is a directory (collection): webdav.ListDirectory("https://localhost/DAV/"); bool isDir = Convert.ToBoolean(webdav.Config("IsDir[0]"));

An exception will be thrown if an invalid index is specified.

HTTP Config Settings

AcceptEncoding:   Used to tell the server which types of content encodings the client supports.

When AllowHTTPCompression is True, the class adds an Accept-Encoding header to the request being sent to the server. By default, this header's value is "gzip, deflate". This configuration setting allows you to change the value of the Accept-Encoding header. Note: The class only supports gzip and deflate decompression algorithms.

AllowHTTPCompression:   This property enables HTTP compression for receiving data.

This configuration setting enables HTTP compression for receiving data. When set to True (default), the class will accept compressed data. It then will uncompress the data it has received. The class will handle data compressed by both gzip and deflate compression algorithms.

When True, the class adds an Accept-Encoding header to the outgoing request. The value for this header can be controlled by the AcceptEncoding configuration setting. The default value for this header is "gzip, deflate".

The default value is True.

AllowHTTPFallback:   Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.

This configuration setting controls whether HTTP/2 connections are permitted to fall back to HTTP/1.1 when the server does not support HTTP/2. This setting is applicable only when http_version is set to "2.0".

If set to True (default), the class will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the class fails with an error if the server does not support HTTP/2.

The default value is True.

Append:   Whether to append data to LocalFile.

This configuration setting determines whether data will be appended when writing to local_file. When set to True, downloaded data will be appended to local_file. This may be used in conjunction with range to resume a failed download. This is applicable only when local_file is set. The default value is False.

Authorization:   The Authorization string to be sent to the server.

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.

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]".

BytesTransferred:   Contains the number of bytes transferred in the response data.

This configuration setting returns the raw number of bytes from the HTTP response data, before the component processes the data, whether it is chunked or compressed. This returns the same value as the on_transfer event, by BytesTransferred.

ChunkSize:   Specifies the chunk size in bytes when using chunked encoding.

This is applicable only when UseChunkedEncoding is True. This setting specifies the chunk size in bytes to be used when posting data. The default value is 16384.

CompressHTTPRequest:   Set to true to compress the body of a PUT or POST request.

If set to True, the body of a PUT or POST request will be compressed into gzip format before sending the request. The "Content-Encoding" header is also added to the outgoing request.

The default value is False.

EncodeURL:   If set to True the URL will be encoded by the class.

If set to True, the URL passed to the class will be URL encoded. The default value is False.

FollowRedirects:   Determines what happens when the server issues a redirect.

This option 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 1 (always), the new url for the object is retrieved automatically every time.

If this property is set to 2 (Same Scheme), 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 option is set to 1 (Always), 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, unless this property is set to 1 (Always), in which case 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 0 (Never). In this case, redirects are never followed, and the class fails with an error instead.

Following are the valid options:

  • 0 - Never
  • 1 - Always
  • 2 - Same Scheme

GetOn302Redirect:   If set to True the class will perform a GET on the new location.

The default value is False. If set to True, the class will perform a GET on the new location. Otherwise, it will use the same HTTP method again.

HTTP2HeadersWithoutIndexing:   HTTP2 headers that should not update the dynamic header table with incremental indexing.

HTTP/2 servers maintain a dynamic table of headers and values seen over the course of a connection. Typically, these headers are inserted into the table through incremental indexing (also known as HPACK, defined in RFC 7541). To tell the component not to use incremental indexing for certain headers, and thus not update the dynamic table, set this configuration option to a comma-delimited list of the header names.

HTTPVersion:   The version of HTTP used by the class.

This property specifies the HTTP version used by the class. Possible values are as follows:

  • "1.0"
  • "1.1" (default)
  • "2.0"
  • "3.0"

When using HTTP/2 ("2.0"), additional restrictions apply. Please see the following notes for details.

HTTP/2 Notes

When using HTTP/2, a secure Secure Sockets Layer/Transport Layer Security (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/2 will result in an error.

If the server does not support HTTP/2, the class will automatically use HTTP/1.1 instead. This is done to provide compatibility without the need for any additional settings. To see which version was used, check NegotiatedHTTPVersion after calling a method. The AllowHTTPFallback setting controls whether this behavior is allowed (default) or disallowed.

HTTP/3 Notes

HTTP/3 is supported only in .NET and Java.

When using HTTP/3, a secure (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/3 will result in an error.

IfModifiedSince:   A date determining the maximum age of the desired document.

If this setting contains a nonempty string, an If-Modified-Since HTTP header is added to the request. The value of this header is used to make the HTTP request conditional: if the requested documented has not been modified since the time specified in the field, a copy of the document will not be returned from the server; instead, a 304 (not modified) response will be returned by the server and the component throws an exception

The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example: Sat, 29 Oct 2017 19:43:31 GMT.

KeepAlive:   Determines whether the HTTP connection is closed after completion of the request.

If True, the component will not send the Connection: Close header. The absence of the Connection header indicates to the server that HTTP persistent connections should be used if supported. Note: Not all servers support persistent connections. You also may explicitly add the Keep-Alive header to the request headers by setting other_headers to Connection: Keep-Alive. If False, the connection will be closed immediately after the server response is received.

The default value for KeepAlive is False.

KerberosSPN:   The Service Principal Name for the Kerberos Domain Controller.

If the Service Principal Name on the Kerberos Domain Controller is not the same as the URL that you are authenticating to, the Service Principal Name should be set here.

LogLevel:   The level of detail that is logged.

This configuration setting controls the level of detail that is logged through the on_log event. Possible values are as follows:

0 (None) No events are logged.
1 (Info - default) Informational events are logged.
2 (Verbose) Detailed data are logged.
3 (Debug) Debug data are logged.

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).

MaxRedirectAttempts:   Limits the number of redirects that are followed in a request.

When follow_redirects is set to any value other than frNever, the class will follow redirects until this maximum number of redirect attempts are made. The default value is 20.

NegotiatedHTTPVersion:   The negotiated HTTP version.

This configuration setting may be queried after the request is complete to indicate the HTTP version used. When http_version is set to "2.0" (if the server does not support "2.0"), then the class will fall back to using "1.1" automatically. This setting will indicate which version was used.

OtherHeaders:   Other headers as determined by the user (optional).

This configuration setting can be set to a string of headers to be appended to the HTTP request headers.

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 configuration setting with caution. If this configuration setting contains invalid headers, HTTP requests may fail.

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

ProxyAuthorization:   The authorization string to be sent to the proxy server.

This is similar to the Authorization configuration setting, but is used for proxy authorization. If this configuration setting contains a nonempty string, a Proxy-Authorization HTTP request header is added to the request. This header conveys proxy Authorization information to the server. If proxy_user and proxy_password are specified, this value is calculated using the algorithm specified by proxy_auth_scheme.

ProxyAuthScheme:   The authorization scheme to be used for the proxy.

This configuration setting is provided for use by classs that do not directly expose Proxy properties.

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

This configuration setting is provided for use by classs that do not directly expose Proxy properties.

ProxyPort:   Port for the proxy server (default 80).

This configuration setting is provided for use by classs that do not directly expose Proxy properties.

ProxyServer:   Name or IP address of a proxy server (optional).

This configuration setting is provided for use by classs that do not directly expose Proxy properties.

ProxyUser:   A user name if authentication is to be used for the proxy.

This configuration setting is provided for use by classs that do not directly expose Proxy properties.

SentHeaders:   The full set of headers as sent by the client.

This configuration setting returns the complete set of raw headers as sent by the client.

StatusLine:   The first line of the last response from the server.

This setting contains the first line of the last response from the server. The format of the line will be [HTTP version] [Result Code] [Description].

TransferredData:   The contents of the last response from the server.

This configuration setting contains the contents of the last response from the server.

TransferredDataLimit:   The maximum number of incoming bytes to be stored by the class.

If TransferredDataLimit is set to 0 (default), no limits are imposed. Otherwise, this reflects the maximum number of incoming bytes that can be stored by the class.

TransferredHeaders:   The full set of headers as received from the server.

This configuration setting returns the complete set of raw headers as received from the server.

TransferredRequest:   The full request as sent by the client.

This configuration setting returns the full request as sent by the client. For performance reasons, the request is not normally saved. Set this configuration setting to ON before making a request to enable it. Following are examples of this request:

.NET Http http = new Http(); http.Config("TransferredRequest=on"); http.PostData = "body"; http.Post("http://someserver.com"); Console.WriteLine(http.Config("TransferredRequest")); C++ HTTP http; http.Config("TransferredRequest=on"); http.SetPostData("body", 5); http.Post("http://someserver.com"); printf("%s\r\n", http.Config("TransferredRequest"));

UseChunkedEncoding:   Enables or Disables HTTP chunked encoding for transfers.

If UseChunkedEncoding is set to True, the class will use HTTP-chunked encoding when posting, if possible. HTTP-chunked encoding allows large files to be sent in chunks instead of all at once. If set to False, the class will not use HTTP-chunked encoding. The default value is False.

Note: Some servers (such as the ASP.NET Development Server) may not support chunked encoding.

UseIDNs:   Whether to encode hostnames to internationalized domain names.

This configuration setting specifies whether hostnames containing non-ASCII characters are encoded to internationalized domain names. When set to True, if a hostname contains non-ASCII characters, it is encoded using Punycode to an IDN (internationalized domain name).

The default value is False and the hostname will always be used exactly as specified. Note: The CodePage setting must be set to a value capable of interpreting the specified host name. For instance, to specify UTF-8, set CodePage to 65001. In the C++ Edition for Windows, the *W version of the class must be used. For instance, DNSW or HTTPW.

UsePlatformHTTPClient:   Whether or not to use the platform HTTP client.

When using this configuration setting, if True, the component will use the default HTTP client for the platform (URLConnection in Java, WebRequest in .NET, or CFHTTPMessage in Mac/iOS) instead of the internal HTTP implementation. This is important for environments in which direct access to sockets is limited or not allowed (e.g., in the Google AppEngine).

Note: This setting is applicable only to Mac/iOS editions.

UserAgent:   Information about the user agent (browser).

This is the value supplied in the HTTP User-Agent header. The default setting is "IPWorks HTTP Component - www.nsoftware.com".

Override the default with the name and version of your software.

TCPClient Config Settings

ConnectionTimeout:   Sets a separate timeout value for establishing a connection.

When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the class will use timeout for establishing a connection and transmitting/receiving data.

FirewallAutoDetect:   Tells the class whether or not to automatically detect and use firewall system settings, if available.

This configuration setting is provided for use by classs that do not directly expose Firewall properties.

FirewallHost:   Name or IP address of firewall (optional).

If a FirewallHost is given, requested connections will be authenticated through the specified firewall when connecting.

If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the FirewallHost setting is set to the corresponding address. If the search is not successful, an error is returned.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallPassword:   Password to be used if authentication is to be used when connecting through the firewall.

If FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallPort:   The TCP port for the FirewallHost;.

The FirewallPort is set automatically when FirewallType is set to a valid value.

Note: This configuration setting is provided for use by classs that do not directly expose Firewall properties.

FirewallType:   Determines the type of firewall to connect through.

The appropriate values are as follows:

0No firewall (default setting).
1Connect through a tunneling proxy. FirewallPort is set to 80.
2Connect through a SOCKS4 Proxy. FirewallPort is set to 1080.
3Connect through a SOCKS5 Proxy. FirewallPort is set to 1080.
10Connect through a SOCKS4A Proxy. FirewallPort is set to 1080.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

FirewallUser:   A user name if authentication is to be used connecting through a firewall.

If the FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the Firewall. If the authentication fails, the class fails with an error.

Note: This setting is provided for use by classs that do not directly expose Firewall properties.

KeepAliveInterval:   The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.

When set, TCPKeepAlive will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by KeepAliveTime. If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second.

Note: This value is not applicable in macOS.

KeepAliveTime:   The inactivity time in milliseconds before a TCP keep-alive packet is sent.

When set, TCPKeepAlive will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds.

Linger:   When set to True, connections are terminated gracefully.

This property controls how a connection is closed. The default is True.

In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if LingerTime is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.

In the second scenario, if LingerTime is a positive value, the system will attempt to send pending data until the specified LingerTime is reached. If this attempt fails, then the system will reset the connection.

The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the class returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).

Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.

LingerTime:   Time in seconds to have the connection linger.

LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout.

LocalHost:   The name of the local host through which connections are initiated or accepted.

The local_host setting 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 multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

If the class is connected, the local_host setting 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 multi-homed hosts (machines with more than one IP interface).

LocalPort:   The port in the local host where the class binds.

This must be set before a connection is attempted. It instructs the class to bind to a specific port (or communication endpoint) in the local machine.

Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by local_port after the connection is established.

local_port cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.

This; setting is useful when trying to connect to services that require a trusted port in the client side. An example is the remote shell (rsh) service in UNIX systems.

MaxLineLength:   The maximum amount of data to accumulate when no EOL is found.

MaxLineLength is the size of an internal buffer, which holds received data while waiting for an eol string.

If an eol string is found in the input stream before MaxLineLength bytes are received, the on_data_in event is fired with the EOL parameter set to True, and the buffer is reset.

If no eol is found, and MaxLineLength bytes are accumulated in the buffer, the on_data_in event is fired with the EOL parameter set to False, and the buffer is reset.

The minimum value for MaxLineLength is 256 bytes. The default value is 2048 bytes.

MaxTransferRate:   The transfer rate limit in bytes per second.

This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit.

ProxyExceptionsList:   A semicolon separated list of hosts and IPs to bypass when using a proxy.

This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance:

www.google.com;www.nsoftware.com

TCPKeepAlive:   Determines whether or not the keep alive socket option is enabled.

If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set KeepAliveTime and KeepAliveInterval to configure the timing of the keep-alive packets.

Note: This value is not applicable in Java.

TcpNoDelay:   Whether or not to delay when sending packets.

When true, the socket will send all data that is ready to send at once. When false, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.

By default, this config is set to false.

UseIPv6:   Whether to use IPv6.

When set to 0 (default), the class will use IPv4 exclusively. When set to 1, the class will use IPv6 exclusively. To instruct the class to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to 2. The default value is 0. Possible values are:

0 IPv4 Only
1 IPv6 Only
2 IPv6 with IPv4 fallback

SSL Config Settings

LogSSLPackets:   Controls whether SSL packets are logged when using the internal security API.

When ssl_provider is set to Internal, this setting controls whether SSL packets should be logged. By default, this setting is False, as it is only useful for debugging purposes.

When enabled, SSL packet logs are output using the on_ssl_status event, which will fire each time an SSL packet is sent or received.

Enabling this setting has no effect if ssl_provider is set to Platform.

OpenSSLCADir:   The path to a directory containing CA certificates.

This functionality is available only when the provider is OpenSSL.

The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g. 9d66eef0.0, 9d66eef0.1 etc). OpenSSL recommends to use the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

OpenSSLCAFile:   Name of the file containing the list of CA's trusted by your application.

This functionality is available only when the provider is OpenSSL.

The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by

-----BEGIN CERTIFICATE-----

... (CA certificate in base64 encoding) ...

-----END CERTIFICATE-----

sequences. Before, between, and after the certificates text is allowed which can be used e.g. for descriptions of the certificates. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

OpenSSLCipherList:   A string that controls the ciphers to be used by SSL.

This functionality is available only when the provider is OpenSSL.

The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH".

OpenSSLPrngSeedData:   The data to seed the pseudo random number generator (PRNG).

This functionality is available only when the provider is OpenSSL.

By default OpenSSL uses the device file "/dev/urandom" to seed the PRNG and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG.

ReuseSSLSession:   Determines if the SSL session is reused.

If set to true, the class will reuse the context if and only if the following criteria are met:

  • The target host name is the same.
  • The system cache entry has not expired (default timeout is 10 hours).
  • The application process that calls the function is the same.
  • The logon session is the same.
  • The instance of the class is the same.

SSLCACertFilePaths:   The paths to CA certificate files on Unix/Linux.

This setting specifies the paths on disk to CA certificate files on Unix/Linux.

The value is formatted as a list of paths separated by semicolons. The class will check for the existence of each file in the order specified. When a file is found the CA certificates within the file will be loaded and used to determine the validity of server or client certificates.

The default value is:

/etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem

SSLCACerts:   A newline separated list of CA certificate to use during SSL client authentication.

This setting specifies one or more CA certificates to be included in the request when performing SSL client authentication. Some servers require the entire chain, including CA certificates, to be presented when performing SSL client authentication. The value of this setting is a newline (CrLf) separated list of certificates. For instance:

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

SSLCheckCRL:   Whether to check the Certificate Revocation List for the server certificate.

This setting specifies whether the class will check the Certificate Revocation List specified by the server certificate. If set to 1 or 2, the class will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The class will then make HTTP requests to each CRL endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the class fails with an error.

When set to 0 (default) the CRL check will not be performed by the class. When set to 1, it will attempt to perform the CRL check, but will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported.

This configuration setting is only supported in the Java, C#, and C++ editions. In the C++ edition, it is only supported on Windows operating systems.

SSLCipherStrength:   The minimum cipher strength used for bulk encryption.

This minimum cipher strength largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated.

Please note that this setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the on_ssl_status event.

Use this setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.

When the provider is OpenSSL, SSLCipherStrength is currently not supported. This functionality is instead made available through the OpenSSLCipherList config setting.

SSLEnabledCipherSuites:   The cipher suite to be used in an SSL negotiation.

The enabled cipher suites to be used in SSL negotiation.

By default, the enabled cipher suites will include all available ciphers ("*").

The special value "*" means that the class will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.

Multiple cipher suites are separated by semicolons.

Example values when ssl_provider is set to Platform: obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=CALG_AES_256"); obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES"); Possible values when ssl_provider is set to Platform include:

  • CALG_3DES
  • CALG_3DES_112
  • CALG_AES
  • CALG_AES_128
  • CALG_AES_192
  • CALG_AES_256
  • CALG_AGREEDKEY_ANY
  • CALG_CYLINK_MEK
  • CALG_DES
  • CALG_DESX
  • CALG_DH_EPHEM
  • CALG_DH_SF
  • CALG_DSS_SIGN
  • CALG_ECDH
  • CALG_ECDH_EPHEM
  • CALG_ECDSA
  • CALG_ECMQV
  • CALG_HASH_REPLACE_OWF
  • CALG_HUGHES_MD5
  • CALG_HMAC
  • CALG_KEA_KEYX
  • CALG_MAC
  • CALG_MD2
  • CALG_MD4
  • CALG_MD5
  • CALG_NO_SIGN
  • CALG_OID_INFO_CNG_ONLY
  • CALG_OID_INFO_PARAMETERS
  • CALG_PCT1_MASTER
  • CALG_RC2
  • CALG_RC4
  • CALG_RC5
  • CALG_RSA_KEYX
  • CALG_RSA_SIGN
  • CALG_SCHANNEL_ENC_KEY
  • CALG_SCHANNEL_MAC_KEY
  • CALG_SCHANNEL_MASTER_HASH
  • CALG_SEAL
  • CALG_SHA
  • CALG_SHA1
  • CALG_SHA_256
  • CALG_SHA_384
  • CALG_SHA_512
  • CALG_SKIPJACK
  • CALG_SSL2_MASTER
  • CALG_SSL3_MASTER
  • CALG_SSL3_SHAMD5
  • CALG_TEK
  • CALG_TLS1_MASTER
  • CALG_TLS1PRF
Example values when ssl_provider is set to Internal: obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_DH_ANON_WITH_AES_128_CBC_SHA"); Possible values when ssl_provider is set to Internal include:
  • TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
  • TLS_RSA_WITH_AES_256_GCM_SHA384
  • TLS_RSA_WITH_AES_128_GCM_SHA256
  • TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
  • TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
  • TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
  • TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
  • TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
  • TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
  • TLS_DH_RSA_WITH_AES_128_GCM_SHA256 (Not Recommended)
  • TLS_DH_RSA_WITH_AES_256_GCM_SHA384 (Not Recommended)
  • TLS_DH_DSS_WITH_AES_128_GCM_SHA256 (Not Recommended)
  • TLS_DH_DSS_WITH_AES_256_GCM_SHA384 (Not Recommended)
  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
  • TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
  • TLS_RSA_WITH_AES_256_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
  • TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
  • TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
  • TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
  • TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
  • TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
  • TLS_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
  • TLS_DHE_RSA_WITH_AES_256_CBC_SHA
  • TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
  • TLS_DHE_DSS_WITH_AES_256_CBC_SHA
  • TLS_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
  • TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
  • TLS_DHE_RSA_WITH_AES_128_CBC_SHA
  • TLS_DHE_DSS_WITH_AES_128_CBC_SHA
  • TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
  • TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_3DES_EDE_CBC_SHA
  • TLS_RSA_WITH_DES_CBC_SHA
  • TLS_DHE_RSA_WITH_DES_CBC_SHA
  • TLS_DHE_DSS_WITH_DES_CBC_SHA
  • TLS_RSA_WITH_RC4_128_MD5
  • TLS_RSA_WITH_RC4_128_SHA

When TLS 1.3 is negotiated (see SSLEnabledProtocols) only the following cipher suites are supported:

  • TLS_AES_256_GCM_SHA384
  • TLS_CHACHA20_POLY1305_SHA256
  • TLS_AES_128_GCM_SHA256

SSLEnabledCipherSuites is used together with SSLCipherStrength.

SSLEnabledProtocols:   Used to enable/disable the supported security protocols.

Used to enable/disable the supported security protocols.

Not all supported protocols are enabled by default (the value of this setting is 4032). If you want more granular control over the enabled protocols, you can set this property to the binary 'OR' of one or more of the following values:

TLS1.312288 (Hex 3000)
TLS1.23072 (Hex C00) (Default)
TLS1.1768 (Hex 300) (Default)
TLS1 192 (Hex C0) (Default)
SSL3 48 (Hex 30)
SSL2 12 (Hex 0C)

SSLEnabledProtocols - TLS 1.3 Notes

By default when TLS 1.3 is enabled the class will use the internal TLS implementation.

In editions which are designed to run on Windows ssl_provider can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is only supported on Windows 11 / Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.

If set to 1 (Platform provider) please be aware of the following notes:

  • The platform provider is only available on Windows 11 / Windows Server 2022 and up.
  • SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.
  • If SSLEnabledProtocols includes both TLS 1.3 and TLS 1.2 the above restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.

SSLEnableRenegotiation:   Whether the renegotiation_info SSL extension is supported.

This setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This setting is True by default, but can be set to False to disable the extension.

This setting is only applicable when ssl_provider is set to Internal.

SSLIncludeCertChain:   Whether the entire certificate chain is included in the SSLServerAuthentication event.

This setting specifies whether the Encoded parameter of the on_ssl_server_authentication event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the on_ssl_server_authentication event.

If set to True all certificates returned by the server will be present in the Encoded parameter of the on_ssl_server_authentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.

SSLKeyLogFile:   The location of a file where per-session secrets are written for debugging purposes.

This setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes.

When set, the class will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffice for debugging purposes. When writing to this file the class will only append, it will not overwrite previous values.

Note: This setting is only applicable when ssl_provider is set to Internal.

SSLNegotiatedCipher:   Returns the negotiated ciphersuite.

Returns the ciphersuite negotiated during the SSL handshake.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipher[connId]");

SSLNegotiatedCipherStrength:   Returns the negotiated ciphersuite strength.

Returns the strength of the ciphersuite negotiated during the SSL handshake.

Note: For server components (e.g.TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipherStrength[connId]");

SSLNegotiatedCipherSuite:   Returns the negotiated ciphersuite.

Returns the ciphersuite negotiated during the SSL handshake represented as a single string.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipherSuite[connId]");

SSLNegotiatedKeyExchange:   Returns the negotiated key exchange algorithm.

Returns the key exchange algorithm negotiated during the SSL handshake.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedKeyExchange[connId]");

SSLNegotiatedKeyExchangeStrength:   Returns the negotiated key exchange algorithm strength.

Returns the strenghth of the key exchange algorithm negotiated during the SSL handshake.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedKeyExchangeStrength[connId]");

SSLNegotiatedVersion:   Returns the negotiated protocol version.

Returns the protocol version negotiated during the SSL handshake.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedVersion[connId]");

SSLSecurityFlags:   Flags that control certificate verification.

The following flags are defined (specified in hexadecimal notation). They can be or-ed together to exclude multiple conditions:

0x00000001Ignore time validity status of certificate.
0x00000002Ignore time validity status of CTL.
0x00000004Ignore non-nested certificate times.
0x00000010Allow unknown Certificate Authority.
0x00000020Ignore wrong certificate usage.
0x00000100Ignore unknown certificate revocation status.
0x00000200Ignore unknown CTL signer revocation status.
0x00000400Ignore unknown Certificate Authority revocation status.
0x00000800Ignore unknown Root revocation status.
0x00008000Allow test Root certificate.
0x00004000Trust test Root certificate.
0x80000000Ignore non-matching CN (certificate CN not-matching server name).

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

SSLServerCACerts:   A newline separated list of CA certificate to use during SSL server certificate validation.

This setting optionally specifies one or more CA certificates to be used when verifying the server certificate. When verifying the server's certificate the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This setting should only be set if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

The value of this setting is a newline (CrLf) separated list of certificates. For instance:

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

TLS12SignatureAlgorithms:   Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.

This setting specifies the allowed server certificate signature algorithms when ssl_provider is set to Internal and SSLEnabledProtocols is set to allow TLS 1.2.

When specified the class will verify that the server certificate signature algorithm is among the values specified in this setting. If the server certificate signature algorithm is unsupported the class fails with an error.

The format of this value is a comma separated list of hash-signature combinations. For instance: TCPClient.SSLProvider = TCPClientSSLProviders.sslpInternal; TCPClient.Config("SSLEnabledProtocols=3072"); //TLS 1.2 TCPClient.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa"); The default value for this setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa.

In order to not restrict the server's certificate signature algorithm, specify an empty string as the value for this setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.

TLS12SupportedGroups:   The supported groups for ECC.

This setting specifies a comma separated list of named groups used in TLS 1.2 for ECC.

The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.

When using TLS 1.2 and ssl_provider is set to Internal, the values refer to the supported groups for ECC. The following values are supported:

  • "ecdhe_secp256r1" (default)
  • "ecdhe_secp384r1" (default)
  • "ecdhe_secp521r1" (default)

TLS13KeyShareGroups:   The groups for which to pregenerate key shares.

This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional round trip during the handshake if the group is supported by the server.

The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result only some groups are included by default in this setting.

Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used which is not present in this list it will incur an additional round trip and time to generate the key share for that group.

In most cases this setting does not need to be modified. This should only be modified if there is a specific reason to do so.

The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072

The values are ordered from most preferred to least preferred. The following values are supported:

  • "ecdhe_x25519" (default)
  • "ecdhe_x448"
  • "ecdhe_secp256r1" (default)
  • "ecdhe_secp384r1" (default)
  • "ecdhe_secp521r1"
  • "ffdhe_2048" (default)
  • "ffdhe_3072" (default)
  • "ffdhe_4096"
  • "ffdhe_6144"
  • "ffdhe_8192"

TLS13SignatureAlgorithms:   The allowed certificate signature algorithms.

This setting holds a comma separated list of allowed signature algorithms. Possible values are:

  • "ed25519" (default)
  • "ed448" (default)
  • "ecdsa_secp256r1_sha256" (default)
  • "ecdsa_secp384r1_sha384" (default)
  • "ecdsa_secp521r1_sha512" (default)
  • "rsa_pkcs1_sha256" (default)
  • "rsa_pkcs1_sha384" (default)
  • "rsa_pkcs1_sha512" (default)
  • "rsa_pss_sha256" (default)
  • "rsa_pss_sha384" (default)
  • "rsa_pss_sha512" (default)
The default value is rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448. This setting is only applicable when SSLEnabledProtocols includes TLS 1.3.
TLS13SupportedGroups:   The supported groups for (EC)DHE key exchange.

This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange. This setting should only be modified if there is a specific reason to do so.

The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192

The values are ordered from most preferred to least preferred. The following values are supported:

  • "ecdhe_x25519" (default)
  • "ecdhe_x448" (default)
  • "ecdhe_secp256r1" (default)
  • "ecdhe_secp384r1" (default)
  • "ecdhe_secp521r1" (default)
  • "ffdhe_2048" (default)
  • "ffdhe_3072" (default)
  • "ffdhe_4096" (default)
  • "ffdhe_6144" (default)
  • "ffdhe_8192" (default)

Socket Config Settings

AbsoluteTimeout:   Determines whether timeouts are inactivity timeouts or absolute timeouts.

If AbsoluteTimeout is set to True, any method which does not complete within Timeout seconds will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.

Note: This option is not valid for UDP ports.

FirewallData:   Used to send extra data to the firewall.

When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g. headers for custom authentication schemes).

InBufferSize:   The size in bytes of the incoming queue of the socket.

This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. Increasing the value of the InBufferSize setting can provide significant improvements in performance in some cases.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the InBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

OutBufferSize:   The size in bytes of the outgoing queue of the socket.

This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. Increasing the value of the OutBufferSize setting can provide significant improvements in performance in some cases.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the OutBufferSize reverts to its defined size. The same happens if you attempt to make it too large or too small.

Base Config Settings

BuildInfo:   Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

CodePage:   The system code page used for Unicode to Multibyte translations.

The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:

IdentifierName
037IBM EBCDIC - U.S./Canada
437OEM - United States
500IBM EBCDIC - International
708Arabic - ASMO 708
709Arabic - ASMO 449+, BCON V4
710Arabic - Transparent Arabic
720Arabic - Transparent ASMO
737OEM - Greek (formerly 437G)
775OEM - Baltic
850OEM - Multilingual Latin I
852OEM - Latin II
855OEM - Cyrillic (primarily Russian)
857OEM - Turkish
858OEM - Multilingual Latin I + Euro symbol
860OEM - Portuguese
861OEM - Icelandic
862OEM - Hebrew
863OEM - Canadian-French
864OEM - Arabic
865OEM - Nordic
866OEM - Russian
869OEM - Modern Greek
870IBM EBCDIC - Multilingual/ROECE (Latin-2)
874ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875IBM EBCDIC - Modern Greek
932ANSI/OEM - Japanese, Shift-JIS
936ANSI/OEM - Simplified Chinese (PRC, Singapore)
949ANSI/OEM - Korean (Unified Hangul Code)
950ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026IBM EBCDIC - Turkish (Latin-5)
1047IBM EBCDIC - Latin 1/Open System
1140IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141IBM EBCDIC - Germany (20273 + Euro symbol)
1142IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144IBM EBCDIC - Italy (20280 + Euro symbol)
1145IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147IBM EBCDIC - France (20297 + Euro symbol)
1148IBM EBCDIC - International (500 + Euro symbol)
1149IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201Unicode UCS-2 Big-Endian
1250ANSI - Central European
1251ANSI - Cyrillic
1252ANSI - Latin I
1253ANSI - Greek
1254ANSI - Turkish
1255ANSI - Hebrew
1256ANSI - Arabic
1257ANSI - Baltic
1258ANSI/OEM - Vietnamese
1361Korean (Johab)
10000MAC - Roman
10001MAC - Japanese
10002MAC - Traditional Chinese (Big5)
10003MAC - Korean
10004MAC - Arabic
10005MAC - Hebrew
10006MAC - Greek I
10007MAC - Cyrillic
10008MAC - Simplified Chinese (GB 2312)
10010MAC - Romania
10017MAC - Ukraine
10021MAC - Thai
10029MAC - Latin II
10079MAC - Icelandic
10081MAC - Turkish
10082MAC - Croatia
12000Unicode UCS-4 Little-Endian
12001Unicode UCS-4 Big-Endian
20000CNS - Taiwan
20001TCA - Taiwan
20002Eten - Taiwan
20003IBM5550 - Taiwan
20004TeleText - Taiwan
20005Wang - Taiwan
20105IA5 IRV International Alphabet No. 5 (7-bit)
20106IA5 German (7-bit)
20107IA5 Swedish (7-bit)
20108IA5 Norwegian (7-bit)
20127US-ASCII (7-bit)
20261T.61
20269ISO 6937 Non-Spacing Accent
20273IBM EBCDIC - Germany
20277IBM EBCDIC - Denmark/Norway
20278IBM EBCDIC - Finland/Sweden
20280IBM EBCDIC - Italy
20284IBM EBCDIC - Latin America/Spain
20285IBM EBCDIC - United Kingdom
20290IBM EBCDIC - Japanese Katakana Extended
20297IBM EBCDIC - France
20420IBM EBCDIC - Arabic
20423IBM EBCDIC - Greek
20424IBM EBCDIC - Hebrew
20833IBM EBCDIC - Korean Extended
20838IBM EBCDIC - Thai
20866Russian - KOI8-R
20871IBM EBCDIC - Icelandic
20880IBM EBCDIC - Cyrillic (Russian)
20905IBM EBCDIC - Turkish
20924IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932JIS X 0208-1990 & 0121-1990
20936Simplified Chinese (GB2312)
21025IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027Extended Alpha Lowercase
21866Ukrainian (KOI8-U)
28591ISO 8859-1 Latin I
28592ISO 8859-2 Central Europe
28593ISO 8859-3 Latin 3
28594ISO 8859-4 Baltic
28595ISO 8859-5 Cyrillic
28596ISO 8859-6 Arabic
28597ISO 8859-7 Greek
28598ISO 8859-8 Hebrew
28599ISO 8859-9 Latin 5
28605ISO 8859-15 Latin 9
29001Europa 3
38598ISO 8859-8 Hebrew
50220ISO 2022 Japanese with no halfwidth Katakana
50221ISO 2022 Japanese with halfwidth Katakana
50222ISO 2022 Japanese JIS X 0201-1989
50225ISO 2022 Korean
50227ISO 2022 Simplified Chinese
50229ISO 2022 Traditional Chinese
50930Japanese (Katakana) Extended
50931US/Canada and Japanese
50933Korean Extended and Korean
50935Simplified Chinese Extended and Simplified Chinese
50936Simplified Chinese
50937US/Canada and Traditional Chinese
50939Japanese (Latin) Extended and Japanese
51932EUC - Japanese
51936EUC - Simplified Chinese
51949EUC - Korean
51950EUC - Traditional Chinese
52936HZ-GB2312 Simplified Chinese
54936Windows XP: GB18030 Simplified Chinese (4 Byte)
57002ISCII Devanagari
57003ISCII Bengali
57004ISCII Tamil
57005ISCII Telugu
57006ISCII Assamese
57007ISCII Oriya
57008ISCII Kannada
57009ISCII Malayalam
57010ISCII Gujarati
57011ISCII Punjabi
65000Unicode UTF-7
65001Unicode UTF-8

The following is a list of valid code page identifiers for Mac OS only:

IdentifierName
1ASCII
2NEXTSTEP
3JapaneseEUC
4UTF8
5ISOLatin1
6Symbol
7NonLossyASCII
8ShiftJIS
9ISOLatin2
10Unicode
11WindowsCP1251
12WindowsCP1252
13WindowsCP1253
14WindowsCP1254
15WindowsCP1250
21ISO2022JP
30MacOSRoman
10UTF16String
0x90000100UTF16BigEndian
0x94000100UTF16LittleEndian
0x8c000100UTF32String
0x98000100UTF32BigEndian
0x9c000100UTF32LittleEndian
65536Proprietary

LicenseInfo:   Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:

  • Product: The product the license is for.
  • Product Key: The key the license was generated from.
  • License Source: Where the license was found (e.g., RuntimeLicense, License File).
  • License Type: The type of license installed (e.g., Royalty Free, Single Server).
  • Last Valid Build: The last valid build number for which the license will work.
ProcessIdleEvents:   Whether the class uses its internal event loop to process events when the main thread is idle.

If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True.

SelectWaitMillis:   The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.

If there are no events to process when do_events is called, the class will wait for the amount of time specified here before returning. The default value is 20.

UseInternalSecurityAPI:   Tells the class whether or not to use the system security libraries or an internal implementation.

By default the class will use the system security libraries to perform cryptographic functions where applicable. Setting this to True tells the class to use the internal implementation instead of using the system's security API.

CalDAV Errors

CalDAV Errors

222   Property set with an improper enumeration value.
234   Missing required field.
432   Invalid array property index.
471   Server error. Description contains detailed information.
476   No lock tokens.
700   Bad response received from CalDAV server. Unable to parse.
701   The CalDAV server returned and empty calendar.
702   When creating an event containing alarms, each alarm in the event requires a Trigger.
703   Both Alarm Duration and Repeat must be specified, or neither should be specified.
704   The class was unable to complete the requested action because a required property has not been set.

The class may also return one of the following error codes, which are inherited from other classes.

HTTP Errors

118   Firewall Error. Error description contains detailed message.
143   Busy executing current method.
151   HTTP protocol error. The error message has the server response.
152   No server specified in url
153   Specified url_scheme is invalid.
155   Range operation is not supported by server.
156   Invalid cookie index (out of range).
301   Interrupted.
302   Can't open attached_file.

The class may also return one of the following error codes, which are inherited from other classes.

TCPClient Errors

100   You cannot change the remote_port at this time. A connection is in progress.
101   You cannot change the remote_host (Server) at this time. A connection is in progress.
102   The remote_host address is invalid (0.0.0.0).
104   Already connected. If you want to reconnect, close the current connection first.
106   You cannot change the local_port at this time. A connection is in progress.
107   You cannot change the local_host at this time. A connection is in progress.
112   You cannot change MaxLineLength at this time. A connection is in progress.
116   remote_port cannot be zero. Please specify a valid service port number.
117   You cannot change the UseConnection option while the class is active.
135   Operation would block.
201   Timeout.
211   Action impossible in control's present state.
212   Action impossible while not connected.
213   Action impossible while listening.
301   Timeout.
302   Could not open file.
434   Unable to convert string to selected CodePage.
1105   Already connecting. If you want to reconnect, close the current connection first.
1117   You need to connect first.
1119   You cannot change the LocalHost at this time. A connection is in progress.
1120   Connection dropped by remote host.

SSL Errors

270   Cannot load specified security library.
271   Cannot open certificate store.
272   Cannot find specified certificate.
273   Cannot acquire security credentials.
274   Cannot find certificate chain.
275   Cannot verify certificate chain.
276   Error during handshake.
280   Error verifying certificate.
281   Could not find client certificate.
282   Could not find server certificate.
283   Error encrypting data.
284   Error decrypting data.

TCP/IP Errors

10004   [10004] Interrupted system call.
10009   [10009] Bad file number.
10013   [10013] Access denied.
10014   [10014] Bad address.
10022   [10022] Invalid argument.
10024   [10024] Too many open files.
10035   [10035] Operation would block.
10036   [10036] Operation now in progress.
10037   [10037] Operation already in progress.
10038   [10038] Socket operation on non-socket.
10039   [10039] Destination address required.
10040   [10040] Message too long.
10041   [10041] Protocol wrong type for socket.
10042   [10042] Bad protocol option.
10043   [10043] Protocol not supported.
10044   [10044] Socket type not supported.
10045   [10045] Operation not supported on socket.
10046   [10046] Protocol family not supported.
10047   [10047] Address family not supported by protocol family.
10048   [10048] Address already in use.
10049   [10049] Can't assign requested address.
10050   [10050] Network is down.
10051   [10051] Network is unreachable.
10052   [10052] Net dropped connection or reset.
10053   [10053] Software caused connection abort.
10054   [10054] Connection reset by peer.
10055   [10055] No buffer space available.
10056   [10056] Socket is already connected.
10057   [10057] Socket is not connected.
10058   [10058] Can't send after socket shutdown.
10059   [10059] Too many references, can't splice.
10060   [10060] Connection timed out.
10061   [10061] Connection refused.
10062   [10062] Too many levels of symbolic links.
10063   [10063] File name too long.
10064   [10064] Host is down.
10065   [10065] No route to host.
10066   [10066] Directory not empty
10067   [10067] Too many processes.
10068   [10068] Too many users.
10069   [10069] Disc Quota Exceeded.
10070   [10070] Stale NFS file handle.
10071   [10071] Too many levels of remote in path.
10091   [10091] Network subsystem is unavailable.
10092   [10092] WINSOCK DLL Version out of range.
10093   [10093] Winsock not loaded yet.
11001   [11001] Host not found.
11002   [11002] Non-authoritative 'Host not found' (try again or check DNS setup).
11003   [11003] Non-recoverable errors: FORMERR, REFUSED, NOTIMP.
11004   [11004] Valid name, no data record (check DNS setup).

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks 2022 Python Edition - Version 22.0 [Build 8369]