# Office365Calendars Class The Office365Calendars class provides an easy way to manage calendars in Microsoft 365. The class includes support for creating, listing and managing both calendars and events. ## Syntax ```text class cloudcalendars.Office365Calendars ``` ## Remarks This class provides an easy to use interface for Microsoft Office365 Calendars. To use the class, first set the [authorization](#authorization-property) property to a valid OAuth token. The Office365Calendars class can be used for creating new calendars, retrieving, deleting and updating existing ones; and several other functionalities supported by the Office365 API. This class requires authentication via OAuth 2.0. First, perform OAuth authentication using the o_auth property to set the appropriate fields for the chosen [o_auth_client_profile](#o_auth_client_profile-property) and [o_auth_grant_type](#o_auth_grant_type-property). The class has the following defaults: | | | | --- | --- | | Authorization Server URL | "https://login.microsoftonline.com/common/oauth2/v2.0/authorize" | | Token Server URL | "https://login.microsoftonline.com/common/oauth2/v2.0/token" | | Scopes | "offline_access mail.readwrite mail.send user.read" | Additionally, depending on how the application is registered (e.g. Multi-tenant) and what [o_auth_grant_type](#o_auth_grant_type-property) is selected (e.g. Client Credentials and Password), it may be required to use the tenant ID rather than "common" in the [o_auth_server_auth_url](#o_auth_server_auth_url-property) and [o_auth_server_token_url](#o_auth_server_token_url-property) properties. In the case of Client Credentials and Password grant types, it is also required to use the "default" scopes of the app registration. See below for examples of the modified URLs and scopes: | | | | --- | --- | | Authorization Server URL | "https://login.microsoftonline.com/{TENANT_ID}/oauth2/v2.0/authorize" | | Token Server URL | "https://login.microsoftonline.com/{TENANT_ID}/oauth2/v2.0/token" | | Scopes | "https://graph.microsoft.com/.default" | Below is a brief description of the different [o_auth_client_profile](#o_auth_client_profile-property) and [o_auth_grant_type](#o_auth_grant_type-property) values that are supported by this class. For a more in-depth description of what needs to be set, refer to the service documentation. ### Application Profile This profile encompasses the most basic grant types that OAuth supports. When this profile is set, all the requests and response handling is done by the class. Depending on the grant type, this may involve launching a browser so a user can login to authenticate with a authorization server. It may also involve starting an embedded web server to receive a response from a redirect. To start the authentication and authorization process, the [authorize](#authorize-method) method should be called. If the authorization and authentication was successful, then the [o_auth_access_token](#o_auth_access_token-property) property will be populated. Additionally, if a *refresh token* was provided the [o_auth_refresh_token](#o_auth_refresh_token-property) property will be populated as well. These values of the fields are for informational purposes. The class will also cache these tokens along with when the [o_auth_access_token](#o_auth_access_token-property) will be expired. When a method that makes requests to the service provider is called or the [authorize](#authorize-method) method is called the class will automatically check to see if the *access token* is expired. If it is, it will then automatically try to get a new [o_auth_access_token](#o_auth_access_token-property). If the [authorize](#authorize-method) method was not used and user interaction would be required, the class will throw an error which can be caught. When user interaction is needed depends on what grant type is set in the [o_auth_grant_type](#o_auth_grant_type-property) property. To force the component to only check the *access token* when the [authorize](#authorize-method) method is called, the [OAuthAutomaticRefresh](#OAuthAutomaticRefresh) configuration setting can be set to false. A brief description of the supported values for the [o_auth_grant_type](#o_auth_grant_type-property) property are below. For more information, see the service documentation. **Authorization Code** When using the *Authorization Code* grant type, the class will use an *authorization code* to get an *access token*. For this [o_auth_grant_type](#o_auth_grant_type-property) the class expects a [o_auth_client_id](#o_auth_client_id-property), [o_auth_client_secret](#o_auth_client_secret-property), [o_auth_server_auth_url](#o_auth_server_auth_url-property), and [o_auth_server_token_url](#o_auth_server_token_url-property) to be set. When the [authorize](#authorize-method) method is called, the component will start the embedded web server and launch the browser so the user can authorize the application. Once the user authorizes, the service provider will redirect them to the embedded web server and the class will parse the *authorization code*, setting the [o_auth_authorization_code](#o_auth_authorization_code-property) property, from the redirect. Immediately, the class will make a request to the token server to exchange the *authorization code* for an *access token*. The token server will return an *access token* and possibly a *refresh token*. If the [o_auth_refresh_token](#o_auth_refresh_token-property) property is set, or a *refresh token* is cached, then the class will not launch the browser and use the *refresh token* in its request to the token server instead of an *authorization code*. **Example: ** ```csharp Office365Calendars office365 = new Office365Calendars(); office365.OAuth.ClientProfile = CloudOAuthClientProfiles.cocpApplication; office365.OAuth.GrantType = OAuthSettingsGrantTypes.cogtAuthorizationCode; office365.OAuth.ClientId = CLIENT_ID; office365.OAuth.ClientSecret = CLIENT_SECRET; office365.Authorize(); ``` **Client Credentials** When using the *Client Credentials* grant type, the class will act as a service instead of authorizing and authenticating as a user. This allows for the class to avoid user interaction. This is typically used when running in an application that can not have user access. This grant type requires additional set up to be done in the service providers portal before it can be used. For this [o_auth_grant_type](#o_auth_grant_type-property) the class expects a [o_auth_client_id](#o_auth_client_id-property), [o_auth_client_secret](#o_auth_client_secret-property), and [o_auth_server_token_url](#o_auth_server_token_url-property) to be set. When the [authorize](#authorize-method) method is called, the component will make a request to the token server for an *access token*. The token server will return an *access token* if the application has the authorization to do so. When this *access token* is expired, the component will automatically (see above for detailed description) make a new request to get a fresh one. **Implicit** Note: This grant type is considered insecure and should only be used when necessary. When using the *Implicit* grant type, the class will request the authorization server to get an *access token*. For this [o_auth_grant_type](#o_auth_grant_type-property) the class expects a [o_auth_client_id](#o_auth_client_id-property), [o_auth_client_secret](#o_auth_client_secret-property), and [o_auth_server_auth_url](#o_auth_server_auth_url-property) to be set. When the [authorize](#authorize-method) method is called, the component will start the embedded web server and launch the browser so the user can authorize the application. Once the user authorizes, the service provider will redirect them to the embedded web server and the class will parse the *access token* from the redirect. A disadvantage of the grant type is that can not use a *refresh token* to silently get a new *access token*. Most service providers offer a way to silently get a new *access token*. See the service documentation for specifics. This means the class will not be able to automatically get a fresh token once it expires. **Password** Note: This grant type is considered insecure and should only be used when necessary. When using the *Resource Owner Password Credentials* grant type, the class will authenticate as the resource owner. This allows for the class to avoid user interaction. This grant type often has specific limitations put on it by the service provider. See the service documentation for more details. For this [o_auth_grant_type](#o_auth_grant_type-property) the class requires [OAuthPasswordGrantUsername](#OAuthPasswordGrantUsername), [o_auth_client_secret](#o_auth_client_secret-property), and [o_auth_server_token_url](#o_auth_server_token_url-property) to be set. The [o_auth_client_secret](#o_auth_client_secret-property) should be set to the password of the account instead of a typical secret. In some cases, the [o_auth_client_id](#o_auth_client_id-property) also needs to be set. When the [authorize](#authorize-method) method is called, the component will make a request to the token server for an *access token* using the username and password. The token server will return an *access token* if the authentication was successful. When this *access token* is expired, the component will automatically (see above for detailed description) make a new request to get a fresh one. ### Web Profile This profile is similar to setting the class to the Application profile and Authorization Code grant type except the class will not launch the browser. It is typically used in situations where there is a back-end that is supporting some front end. This profile expects that [o_auth_client_id](#o_auth_client_id-property), [o_auth_client_secret](#o_auth_client_secret-property), [o_auth_server_auth_url](#o_auth_server_auth_url-property), [o_auth_server_token_url](#o_auth_server_token_url-property), and the [o_auth_return_url](#o_auth_return_url-property) properties to be set. Before calling the [authorize](#authorize-method) method, the [o_auth_web_auth_url](#o_auth_web_auth_url-property) property should be queried to get a URL. This URL should be used to redirect the user to the authorization page for the service provider. The *redirect_uri* parameter of this URL is mapped to the [o_auth_return_url](#o_auth_return_url-property) property. The [o_auth_return_url](#o_auth_return_url-property) property should be set to some web server that will parse the *authorization code* out of the query parameter from the redirect. Once the *authorization code* is parsed, it should be passed back to the server where it is then set to the [o_auth_authorization_code](#o_auth_authorization_code-property) property. Once that is set, the [authorize](#authorize-method) method can be called to exchange the *authorization code* for an *access token* and *refresh token* if provided. The class will then cache these values like normal and use them to make requests. If the [o_auth_refresh_token](#o_auth_refresh_token-property) field is set, or a *refresh token* is cached, then the [authorize](#authorize-method) method can immediately be called to make a request to the token server to get a new *access token*. ### External OAuth Support For complex profiles or grant types, or for more control of the flow, it is possible to perform OAuth authentication using a separate OAuth client. Once complete you should have an authorization string which looks like: ```text Bearer ACCESS_TOKEN_VALUE ``` Assign this value to the [authorization](#authorization-property) property before attempting any operations. Setting the [authorization](#authorization-property) property will cause the class to ignore the values set in the o_auth property. For Example: ```csharp Oauth oauth = new Oauth(); oauth.ClientId = "CLIENT_ID"; oauth.ClientSecret = "CLIENT_SECRET"; oauth.ServerAuthURL = "https://login.microsoftonline.com/common/oauth2/v2.0/authorize"; oauth.ServerTokenURL = "https://login.microsoftonline.com/common/oauth2/v2.0/token"; oauth.AuthorizationScope = "offline_access user.read mail.readwrite mail.send mailboxsettings.readwrite user.readwrite Contacts.Read Contacts.ReadWrite"; oauth.GrantType = OauthGrantTypes.ogtAuthorizationCode; office365.Authorization = oauth.GetAuthorization(); ``` Consult the documentation for the service for more information about supported scope values and more details on OAuth authentication. ### Creating a Calendar To create a calendar using the Office365Calendars components we make use of the [create_calendar](#create_calendar-method) method. The [create_calendar](#create_calendar-method) method will create a new calendar with a name specified through the *Name* parameter. **Creating a calendar:** ```csharp office365.CreateCalendar("My Calendar"); ``` After creating a calendar, select the calendar to be edited in the calendars collection, edit its fields and make a call to the [update_calendar](#update_calendar-method) method. To edit the newly created calendar select the first calendar in the collection. **Example (Update The First Calendar Of The Collection)** ```csharp // Set properties to update office365.Calendars[0].Color = TOfficeColors.occLightGreen; office365.Calendars[0].Name = "new name"; office365.UpdateCalendar(0); ``` ### Listing Calendars Information about calendars fetched by the component can be accessed through the calendars properties. The calendars properties is populated when the [list_calendars](#list_calendars-method) method is called. By default, the component will fetch one page of 100 calendars when [list_calendars](#list_calendars-method) is called. If additional calendars remain in the folder, the [ListCalendarsMarker](#ListCalendarsMarker) property will be populated, it contains the nextPageToken that will be included in the next request as a parameter if [list_calendars](#list_calendars-method) is then called again on the same folder, if called the next page of calendars will be fetched. The example below populates the calendars properties with all the calendars associated with the account. ```csharp do { office365.ListCalendars(); } while (office365.Config("ListCalendarsMarker").Length > 0); ``` ### Creating Events To create a new event use the [create_event](#create_event-method) method. The newly created event is added at the beginning of the events properties. **Example (Create a new event in a specific calendar)** ```csharp office365.CreateEvent("My event", "2024-11-08T16:00:00", "2024-11-08T17:00:00", office365.Calendars[0].Id); // The ID of the calendar to which the event will belong to ``` After creating an event with the basic information, select the event to be edited in the events collection, edit its fields and make a call to the [update_event](#update_event-method) method. To edit the newly created event select the first event in the collection. **Example (Update The First Event Of The List)** ```csharp // Set properties to update office365.Events[0].Subject = "new event name"; office365.Events[0].AttendeesCount = 2; office365.Events[0].AttendeeIndex = 0; office365.Events[0].AttendeeEmail = "person1@example.com"; office365.Events[0].AttendeeStatusResponse = TOCAttendeeStatusResponses.oasrAccepted; office365.Events[0].AttendeeType = TOCAttendeeTypes.ocatOptional; office365.Events[0].AttendeeIndex = 1; office365.Events[0].AttendeeEmail = "person2@example.com"; office365.Events[0].AttendeeStatusResponse = TOCAttendeeStatusResponses.oasrAccepted; office365.Events[0].AttendeeType = TOCAttendeeTypes.ocatRequired; // Set a reminder 15 minutes before office365.Events[0].IsReminderOn = true; office365.Events[0].ReminderMinutesBeforeStart = 15; office365.UpdateEvent(0); ``` ### Listing Events Information about events fetched by the component can be accessed through the events properties. The events properties is populated when the [list_events](#list_events-method) method is called. By default, the component will fetch one page of 100 events when [list_events](#list_events-method) is called. If additional events remain, the [list_events_marker](#list_events_marker-property) property will be populated, it contains the nextPageToken that will be included in the next request as a parameter if [list_events](#list_events-method) is then called again on the same calendar, if called the next page of events will be fetched. The example below populates the events properties with all the events associated with the specified calendar. ```csharp do { office365.ListEvents(office365.Calendars[0].Id); } while (office365.ListEventsMarker.Length > 0); ``` ### Retrieving an Event To retrieve an event use the [get_event](#get_event-method) method and provide the Id of the event. The event is added to the beginning of the events collection. **Example (Retrieve an Event)** ```csharp // Retrieve an event by its ID string eventId = "12345"; // Replace with the actual event ID gcal.GetEvent(eventId); // Access the retrieved event var retrievedEvent = office365.Events[0]; retrievedEvent.Subject; //event subject retrievedEvent.StartDateTime; //start dateTime of event retrievedEvent.AttendeeStatusResponse; //attendee status response gcal.GetEventField(0, "/json/subject"); //event name gcal.GetEventField(0, "/json/isCancelled"); //if the event is cancelled ``` ### Deleting an Event To delete an event use the [delete_event](#delete_event-method) method, provide the Id of the event and the Id of the calendar as the argument. The event will stay in the events collection until [list_events](#list_events-method) method is called again. **Example (Delete Events** ```csharp // List events and delete the event named "new event name" office365.ListEvents(office365.Calendars[0].Id); for (int i = 0; i < office365.Events.Count; i++) { if (office365.Events[i].Subject == "new event name") { office365.DeleteEvent(office365.Calendars[0].Id, office365.Events[i].Id); break; } // Note: the component would let you name more than one event with the same name so the example would delete the first encounter with the event that has the specified name } ``` ## Property List *The following is the full list of the properties of the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [attachments_count](#attachments_count-property) | The number of records in the Attachment arrays. | | [attachment_content_type](#attachment_content_type-property) | This property contains the content type of the attachment. | | [attachment_data](#attachment_data-property) | This property contains the raw data of the attachment. | | [attachment_event_id](#attachment_event_id-property) | This property contains the event identifier of the attachment. | | [attachment_file_name](#attachment_file_name-property) | This property contains the local file name associated with the attachment. | | [attachment_id](#attachment_id-property) | This property contains the attachment identifier of the attachment. | | [attachment_is_inline](#attachment_is_inline-property) | This property is true if the attachment is an inline attachment. | | [attachment_json](#attachment_json-property) | A JSON representation of the attachment. | | [attachment_last_modified_date](#attachment_last_modified_date-property) | This property contains the date and time when the attachment was last modified. | | [attachment_name](#attachment_name-property) | This property contains the name of the attachment. | | [attachment_size](#attachment_size-property) | This property contains the size in bytes of the attachment. | | [authorization](#authorization-property) | An OAuth Authorization String. | | [calendars_count](#calendars_count-property) | The number of records in the Calendar arrays. | | [calendar_can_edit](#calendar_can_edit-property) | true if the user can write to the calendar, false otherwise. | | [calendar_can_share](#calendar_can_share-property) | true if the user has the permission to share the calendar, false otherwise. | | [calendar_can_view_private_items](#calendar_can_view_private_items-property) | true if the user can read calendar items that have been marked private, false otherwise. | | [calendar_change_key](#calendar_change_key-property) | Identifies the version of the calendar object. | | [calendar_color](#calendar_color-property) | Specifies the color theme to distinguish the calendar from other calendars in a UI. | | [calendar_hex_color](#calendar_hex_color-property) | The calendar color, expressed in a hex color code. | | [calendar_id](#calendar_id-property) | The unique identifier of the calendar. | | [calendar_is_default_calendar](#calendar_is_default_calendar-property) | True if this is the default calendar where new events are created by default, false otherwise. | | [calendar_is_removable](#calendar_is_removable-property) | Indicates whether this user calendar can be deleted from the user mailbox. | | [calendar_name](#calendar_name-property) | the calendar's name. | | [calendar_owner](#calendar_owner-property) | If set, this represents the user who created or added the calendar. | | [events_count](#events_count-property) | The number of records in the Event arrays. | | [event_attendee_email](#event_attendee_email-property) | Attendee email address. | | [event_attendee_index](#event_attendee_index-property) | Index of attendee to get or set its properties. | | [event_attendee_new_time_end](#event_attendee_new_time_end-property) | Attendee's proposed new event ending time. | | [event_attendee_new_time_end_time_zone](#event_attendee_new_time_end_time_zone-property) | The end time zone that was proposed by attendee. | | [event_attendee_new_time_start](#event_attendee_new_time_start-property) | Attendee's new event starting time. | | [event_attendee_new_time_start_time_zone](#event_attendee_new_time_start_time_zone-property) | The start time zone that was proposed by attendee. | | [event_attendees_count](#event_attendees_count-property) | When retrieving events, it indicates the number of attendees linked to the event. | | [event_attendee_status_response](#event_attendee_status_response-property) | The attendee's response status. | | [event_attendee_status_time](#event_attendee_status_time-property) | The date and time when the response was returned. | | [event_attendee_type](#event_attendee_type-property) | The attendee type. | | [event_body](#event_body-property) | The body of the message associated with the event. | | [event_body_is_html](#event_body_is_html-property) | Indicates the text format of the body is HTML. | | [event_body_preview](#event_body_preview-property) | The preview of the message associated with the event. | | [event_calendar_id](#event_calendar_id-property) | The ID of the calendar that contains the event. | | [event_categories](#event_categories-property) | The categories associated with the event. | | [event_change_key](#event_change_key-property) | Identifies the version of the event object. | | [event_created_date_time](#event_created_date_time-property) | The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. | | [event_end_date_time](#event_end_date_time-property) | The date, time, and time zone that the event ends. | | [event_end_time_zone](#event_end_time_zone-property) | The current end time zone. | | [event_type](#event_type-property) | The event type. | | [event_has_attachments](#event_has_attachments-property) | Set to true if the event has attachments. | | [event_id](#event_id-property) | The unique identifier of the event. | | [event_importance](#event_importance-property) | The importance of the event. | | [event_is_all_day](#event_is_all_day-property) | Set to true if the event lasts all day. | | [event_is_cancelled](#event_is_cancelled-property) | Set to true if the event has been canceled. | | [event_is_reminder_on](#event_is_reminder_on-property) | Set to true if an alert is set to remind the user of the event. | | [event_json](#event_json-property) | A JSON representation of the event. | | [event_last_modified_date_time](#event_last_modified_date_time-property) | The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. | | [event_original_end_time_zone](#event_original_end_time_zone-property) | The end time zone that was set when the event was created. | | [event_original_start_date_time](#event_original_start_date_time-property) | Represents the start time of an event when it is initially created as an occurrence or exception in a recurring series. | | [event_original_start_time_zone](#event_original_start_time_zone-property) | The start time zone that was set when the event was created. | | [event_recur_day_of_month](#event_recur_day_of_month-property) | The day of the month on which the event occurs. | | [event_recur_days_of_week](#event_recur_days_of_week-property) | A space separated collection of the days of the week on which the event occurs. | | [event_recur_end_date](#event_recur_end_date-property) | The date to stop applying the recurrence pattern. | | [event_recur_first_day_of_week](#event_recur_first_day_of_week-property) | The first day of the week. | | [event_recur_index](#event_recur_index-property) | Specifies on which instance of the allowed days specified in daysOfWeek the event occurs, counted from the first instance in the month. | | [event_recur_interval](#event_recur_interval-property) | The number of units between occurrences, where units can be in days, weeks, months, or years, depending on the type. | | [event_recur_month](#event_recur_month-property) | The month in which the event occurs. | | [event_recur_number_of_occurrences](#event_recur_number_of_occurrences-property) | The number of times to repeat the event. | | [event_recur_range_type](#event_recur_range_type-property) | The recurrence range. | | [event_recur_start_date](#event_recur_start_date-property) | The date to start applying the recurrence pattern. | | [event_recur_time_zone](#event_recur_time_zone-property) | Time zone for the startDate and endDate properties. | | [event_recur_type](#event_recur_type-property) | The recurrence pattern type Possible values are: 0 (ocrtDaily) 1 (ocrtWeekly) 2 (ocrtAbsoluteMonthly) 3 (ocrtRelativeMonthly) 4 (ocrtAbsoluteYearly) 5 (ocrtRelativeYearly) . | | [event_reminder_minutes_before_start](#event_reminder_minutes_before_start-property) | The number of minutes before the event start time that the reminder alert occurs. | | [event_sensitivity](#event_sensitivity-property) | The event sensitivity Possible values are: 0 (ocsNormal) 1 (ocsPersonal) 2 (ocsPrivate) 3 (ocsConfidential) . | | [event_series_master_id](#event_series_master_id-property) | The ID for the recurring series master item, if this event is part of a recurring series. | | [event_show_as](#event_show_as-property) | The status to show. | | [event_start_date_time](#event_start_date_time-property) | The start date, time, and time zone of the event. | | [event_start_time_zone](#event_start_time_zone-property) | The current start time zone. | | [event_subject](#event_subject-property) | The text of the event's subject line. | | [firewall_auto_detect](#firewall_auto_detect-property) | Whether to automatically detect and use firewall system settings, if available. | | [firewall_host](#firewall_host-property) | The name or IP address of the firewall (optional). | | [firewall_password](#firewall_password-property) | A password if authentication is to be used when connecting through the firewall. | | [firewall_port](#firewall_port-property) | The Transmission Control Protocol (TCP) port for the firewall Host . | | [firewall_type](#firewall_type-property) | The type of firewall to connect through. | | [firewall_user](#firewall_user-property) | A username if authentication is to be used when connecting through a firewall. | | [list_events_marker](#list_events_marker-property) | The page marker for listing events. | | [o_auth_access_token](#o_auth_access_token-property) | The access token returned by the authorization server. | | [o_auth_authorization_code](#o_auth_authorization_code-property) | The authorization code that is exchanged for an access token. | | [o_auth_authorization_scope](#o_auth_authorization_scope-property) | The scope request or response parameter used during authorization. | | [o_auth_client_id](#o_auth_client_id-property) | The id of the client assigned when registering the application. | | [o_auth_client_profile](#o_auth_client_profile-property) | The type of client that is requesting authorization. | | [o_auth_client_secret](#o_auth_client_secret-property) | The secret value for the client assigned when registering the application. | | [o_auth_grant_type](#o_auth_grant_type-property) | The OAuth grant type used to acquire an OAuth access token. | | [o_auth_refresh_token](#o_auth_refresh_token-property) | Specifies the refresh token received from or sent to the authorization server. | | [o_auth_request_refresh_token](#o_auth_request_refresh_token-property) | Specifies whether the class will request a refresh token during authorization. | | [o_auth_return_url](#o_auth_return_url-property) | The URL where the user (browser) returns after authenticating. | | [o_auth_server_auth_url](#o_auth_server_auth_url-property) | The URL of the authorization server. | | [o_auth_server_token_url](#o_auth_server_token_url-property) | The URL of the token server used to obtain the access token. | | [o_auth_timeout](#o_auth_timeout-property) | The amount of time (in seconds) the class will wait for a response from the browser in the LaunchBrowser event. | | [o_auth_web_auth_url](#o_auth_web_auth_url-property) | The URL to which the user should be re-directed for authorization. | | [proxy_auth_scheme](#proxy_auth_scheme-property) | The type of authorization to perform when connecting to the proxy. | | [proxy_auto_detect](#proxy_auto_detect-property) | Whether to automatically detect and use proxy system settings, if available. | | [proxy_password](#proxy_password-property) | A password if authentication is to be used for the proxy. | | [proxy_port](#proxy_port-property) | The Transmission Control Protocol (TCP) port for the proxy Server (default 80). | | [proxy_server](#proxy_server-property) | If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. | | [proxy_ssl](#proxy_ssl-property) | When to use a Secure Sockets Layer (SSL) for the connection to the proxy. | | [proxy_user](#proxy_user-property) | A username if authentication is to be used for the proxy. | | [ssl_accept_server_cert_effective_date](#ssl_accept_server_cert_effective_date-property) | The date on which this certificate becomes valid. | | [ssl_accept_server_cert_encoded](#ssl_accept_server_cert_encoded-property) | The certificate (PEM/Base64 encoded). | | [ssl_accept_server_cert_expiration_date](#ssl_accept_server_cert_expiration_date-property) | The date on which the certificate expires. | | [ssl_accept_server_cert_extended_key_usage](#ssl_accept_server_cert_extended_key_usage-property) | A comma-delimited list of extended key usage identifiers. | | [ssl_accept_server_cert_fingerprint](#ssl_accept_server_cert_fingerprint-property) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [ssl_accept_server_cert_fingerprint_sha1](#ssl_accept_server_cert_fingerprint_sha1-property) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [ssl_accept_server_cert_fingerprint_sha256](#ssl_accept_server_cert_fingerprint_sha256-property) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [ssl_accept_server_cert_issuer](#ssl_accept_server_cert_issuer-property) | The issuer of the certificate. | | [ssl_accept_server_cert_private_key](#ssl_accept_server_cert_private_key-property) | The private key of the certificate (if available). | | [ssl_accept_server_cert_private_key_available](#ssl_accept_server_cert_private_key_available-property) | Whether a PrivateKey is available for the selected certificate. | | [ssl_accept_server_cert_private_key_container](#ssl_accept_server_cert_private_key_container-property) | The name of the PrivateKey container for the certificate (if available). | | [ssl_accept_server_cert_public_key](#ssl_accept_server_cert_public_key-property) | The public key of the certificate. | | [ssl_accept_server_cert_public_key_algorithm](#ssl_accept_server_cert_public_key_algorithm-property) | The textual description of the certificate's public key algorithm. | | [ssl_accept_server_cert_public_key_length](#ssl_accept_server_cert_public_key_length-property) | The length of the certificate's public key (in bits). | | [ssl_accept_server_cert_serial_number](#ssl_accept_server_cert_serial_number-property) | The serial number of the certificate encoded as a string. | | [ssl_accept_server_cert_signature_algorithm](#ssl_accept_server_cert_signature_algorithm-property) | The text description of the certificate's signature algorithm. | | [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property) | The name of the certificate store for the client certificate. | | [ssl_accept_server_cert_store_password](#ssl_accept_server_cert_store_password-property) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. | | [ssl_accept_server_cert_store_type](#ssl_accept_server_cert_store_type-property) | The type of certificate store for this certificate. | | [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property) | The subject of the certificate used for client authentication. | | [ssl_accept_server_cert_subject_alt_names](#ssl_accept_server_cert_subject_alt_names-property) | Comma-separated lists of alternative subject names for the certificate. | | [ssl_accept_server_cert_thumbprint_md5](#ssl_accept_server_cert_thumbprint_md5-property) | The MD5 hash of the certificate. | | [ssl_accept_server_cert_thumbprint_sha1](#ssl_accept_server_cert_thumbprint_sha1-property) | The SHA-1 hash of the certificate. | | [ssl_accept_server_cert_thumbprint_sha256](#ssl_accept_server_cert_thumbprint_sha256-property) | The SHA-256 hash of the certificate. | | [ssl_accept_server_cert_usage](#ssl_accept_server_cert_usage-property) | The text description of UsageFlags . | | [ssl_accept_server_cert_usage_flags](#ssl_accept_server_cert_usage_flags-property) | The flags that show intended use for the certificate. | | [ssl_accept_server_cert_version](#ssl_accept_server_cert_version-property) | The certificate's version number. | | [ssl_cert_effective_date](#ssl_cert_effective_date-property) | The date on which this certificate becomes valid. | | [ssl_cert_encoded](#ssl_cert_encoded-property) | The certificate (PEM/Base64 encoded). | | [ssl_cert_expiration_date](#ssl_cert_expiration_date-property) | The date on which the certificate expires. | | [ssl_cert_extended_key_usage](#ssl_cert_extended_key_usage-property) | A comma-delimited list of extended key usage identifiers. | | [ssl_cert_fingerprint](#ssl_cert_fingerprint-property) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [ssl_cert_fingerprint_sha1](#ssl_cert_fingerprint_sha1-property) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [ssl_cert_fingerprint_sha256](#ssl_cert_fingerprint_sha256-property) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [ssl_cert_issuer](#ssl_cert_issuer-property) | The issuer of the certificate. | | [ssl_cert_private_key](#ssl_cert_private_key-property) | The private key of the certificate (if available). | | [ssl_cert_private_key_available](#ssl_cert_private_key_available-property) | Whether a PrivateKey is available for the selected certificate. | | [ssl_cert_private_key_container](#ssl_cert_private_key_container-property) | The name of the PrivateKey container for the certificate (if available). | | [ssl_cert_public_key](#ssl_cert_public_key-property) | The public key of the certificate. | | [ssl_cert_public_key_algorithm](#ssl_cert_public_key_algorithm-property) | The textual description of the certificate's public key algorithm. | | [ssl_cert_public_key_length](#ssl_cert_public_key_length-property) | The length of the certificate's public key (in bits). | | [ssl_cert_serial_number](#ssl_cert_serial_number-property) | The serial number of the certificate encoded as a string. | | [ssl_cert_signature_algorithm](#ssl_cert_signature_algorithm-property) | The text description of the certificate's signature algorithm. | | [ssl_cert_store](#ssl_cert_store-property) | The name of the certificate store for the client certificate. | | [ssl_cert_store_password](#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. | | [ssl_cert_store_type](#ssl_cert_store_type-property) | The type of certificate store for this certificate. | | [ssl_cert_subject](#ssl_cert_subject-property) | The subject of the certificate used for client authentication. | | [ssl_cert_subject_alt_names](#ssl_cert_subject_alt_names-property) | Comma-separated lists of alternative subject names for the certificate. | | [ssl_cert_thumbprint_md5](#ssl_cert_thumbprint_md5-property) | The MD5 hash of the certificate. | | [ssl_cert_thumbprint_sha1](#ssl_cert_thumbprint_sha1-property) | The SHA-1 hash of the certificate. | | [ssl_cert_thumbprint_sha256](#ssl_cert_thumbprint_sha256-property) | The SHA-256 hash of the certificate. | | [ssl_cert_usage](#ssl_cert_usage-property) | The text description of UsageFlags . | | [ssl_cert_usage_flags](#ssl_cert_usage_flags-property) | The flags that show intended use for the certificate. | | [ssl_cert_version](#ssl_cert_version-property) | The certificate's version number. | | [ssl_provider](#ssl_provider-property) | The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. | | [ssl_server_cert_effective_date](#ssl_server_cert_effective_date-property) | The date on which this certificate becomes valid. | | [ssl_server_cert_encoded](#ssl_server_cert_encoded-property) | The certificate (PEM/Base64 encoded). | | [ssl_server_cert_expiration_date](#ssl_server_cert_expiration_date-property) | The date on which the certificate expires. | | [ssl_server_cert_extended_key_usage](#ssl_server_cert_extended_key_usage-property) | A comma-delimited list of extended key usage identifiers. | | [ssl_server_cert_fingerprint](#ssl_server_cert_fingerprint-property) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [ssl_server_cert_fingerprint_sha1](#ssl_server_cert_fingerprint_sha1-property) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [ssl_server_cert_fingerprint_sha256](#ssl_server_cert_fingerprint_sha256-property) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [ssl_server_cert_issuer](#ssl_server_cert_issuer-property) | The issuer of the certificate. | | [ssl_server_cert_private_key](#ssl_server_cert_private_key-property) | The private key of the certificate (if available). | | [ssl_server_cert_private_key_available](#ssl_server_cert_private_key_available-property) | Whether a PrivateKey is available for the selected certificate. | | [ssl_server_cert_private_key_container](#ssl_server_cert_private_key_container-property) | The name of the PrivateKey container for the certificate (if available). | | [ssl_server_cert_public_key](#ssl_server_cert_public_key-property) | The public key of the certificate. | | [ssl_server_cert_public_key_algorithm](#ssl_server_cert_public_key_algorithm-property) | The textual description of the certificate's public key algorithm. | | [ssl_server_cert_public_key_length](#ssl_server_cert_public_key_length-property) | The length of the certificate's public key (in bits). | | [ssl_server_cert_serial_number](#ssl_server_cert_serial_number-property) | The serial number of the certificate encoded as a string. | | [ssl_server_cert_signature_algorithm](#ssl_server_cert_signature_algorithm-property) | The text description of the certificate's signature algorithm. | | [ssl_server_cert_store](#ssl_server_cert_store-property) | The name of the certificate store for the client certificate. | | [ssl_server_cert_store_password](#ssl_server_cert_store_password-property) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. | | [ssl_server_cert_store_type](#ssl_server_cert_store_type-property) | The type of certificate store for this certificate. | | [ssl_server_cert_subject](#ssl_server_cert_subject-property) | The subject of the certificate used for client authentication. | | [ssl_server_cert_subject_alt_names](#ssl_server_cert_subject_alt_names-property) | Comma-separated lists of alternative subject names for the certificate. | | [ssl_server_cert_thumbprint_md5](#ssl_server_cert_thumbprint_md5-property) | The MD5 hash of the certificate. | | [ssl_server_cert_thumbprint_sha1](#ssl_server_cert_thumbprint_sha1-property) | The SHA-1 hash of the certificate. | | [ssl_server_cert_thumbprint_sha256](#ssl_server_cert_thumbprint_sha256-property) | The SHA-256 hash of the certificate. | | [ssl_server_cert_usage](#ssl_server_cert_usage-property) | The text description of UsageFlags . | | [ssl_server_cert_usage_flags](#ssl_server_cert_usage_flags-property) | The flags that show intended use for the certificate. | | [ssl_server_cert_version](#ssl_server_cert_version-property) | The certificate's version number. | ## 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_attachment](#add_attachment-method) | Adds a file attachment to an existing event. | | [authorize](#authorize-method) | Get the authorization string required to access the protected resource. | | [config](#config-method) | Sets or retrieves a configuration setting. | | [create_calendar](#create_calendar-method) | Creates a new calendar. | | [create_event](#create_event-method) | Creates an event. The timezone is UTC. | | [delete_attachment](#delete_attachment-method) | Deletes an attachment. | | [delete_calendar](#delete_calendar-method) | Deletes a calendar. | | [delete_event](#delete_event-method) | Deletes an event. | | [get_calendar_view](#get_calendar_view-method) | Lists the events as calendar view. | | [get_event](#get_event-method) | Retrieves the event by Id. | | [get_event_field](#get_event_field-method) | Retrieves the event property value by JSONPath. | | [interrupt](#interrupt-method) | Interrupt the current method. | | [list_attachments](#list_attachments-method) | Lists all of a event's attachments. | | [list_calendars](#list_calendars-method) | Lists the calendars. | | [list_events](#list_events-method) | Lists the events. | | [reset](#reset-method) | This method will reset the class. | | [retrieve_attachment](#retrieve_attachment-method) | Retrieves an event attachment. | | [send_custom_request](#send_custom_request-method) | Send a custom HTTP request. | | [set_event_field](#set_event_field-method) | Sets the event field value by JSONPath. | | [update_calendar](#update_calendar-method) | Updates a calendar. | | [update_event](#update_event-method) | Updates an event. | ## 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_attachment_list](#on_attachment_list-event) | Fired when an attachment is retrieved from the server. | | [on_calendar_list](#on_calendar_list-event) | Fired when a calendar is retrieved from the server. | | [on_error](#on_error-event) | Fired when information is available about errors during data delivery. | | [on_event_list](#on_event_list-event) | Fired when an event is retrieved from the server. | | [on_log](#on_log-event) | Fired once for each log message. | | [on_ssl_server_authentication](#on_ssl_server_authentication-event) | Fired after the server presents its certificate to the client. | | [on_ssl_status](#on_ssl_status-event) | Fired when secure connection progress messages are available. | | [on_transfer](#on_transfer-event) | 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.* | | | | --- | --- | | [AttachmentFragmentSize](#AttachmentFragmentSize) | Size of fragments when uploading large attachments. | | [AttachmentSimpleUploadLimit](#AttachmentSimpleUploadLimit) | The threshold to use simple uploads. | | [CalendarsPageSize](#CalendarsPageSize) | Page size limit for fetching calendars. | | [EventsPageSize](#EventsPageSize) | Page size for fetching events. | | [ListCalendarsMarker](#ListCalendarsMarker) | The page marker for listing calendars. | | [QueryParamCount](#QueryParamCount) | The number of custom HTTP Query Parameters. | | [QueryParamName\[i\]](#QueryParamName[i]) | The name of a custom HTTP Query Parameter. | | [QueryParamValue\[i\]](#QueryParamValue[i]) | The value of a custom HTTP Query Parameter. | | [UserId](#UserId) | Sets the Id of a shared mailbox to connect to. | | [XChildCount](#XChildCount) | The number of child elements of the current element. | | [XChildName\[i\]](#XChildName[i]) | The name of the child element. | | [XChildXText\[i\]](#XChildXText[i]) | The inner text of the child element. | | [XElement](#XElement) | The name of the current element. | | [XParent](#XParent) | The parent of the current element. | | [XPath](#XPath) | Provides a way to point to a specific element in the returned XML or JSON response. | | [XSubTree](#XSubTree) | A snapshot of the current element in the document. | | [XText](#XText) | The text of the current element. | | [OAuthAccessTokenExpiration](#OAuthAccessTokenExpiration) | The lifetime of the access token. | | [OAuthAuthorizationTokenType](#OAuthAuthorizationTokenType) | The type of access token returned. | | [OAuthAutomaticRefresh](#OAuthAutomaticRefresh) | Whether or not to refresh an expired access token automatically. | | [OAuthBrowserResponseTimeout](#OAuthBrowserResponseTimeout) | Specifies the amount of time to wait for a response from the browser. | | [OAuthIncludeEmptyRedirectURI](#OAuthIncludeEmptyRedirectURI) | Whether an empty redirect_uri parameter is included in requests. | | [OAuthJWTPayload](#OAuthJWTPayload) | The payload of the JWT access token if present. | | [OAuthJWTXChildCount](#OAuthJWTXChildCount) | The number of child elements of the current element. | | [OauthJWTXChildName\[i\]](#OauthJWTXChildName[i]) | The name of the child element. | | [OAuthJWTXChildXText\[i\]](#OAuthJWTXChildXText[i]) | The inner text of the child element. | | [OAuthJWTXElement](#OAuthJWTXElement) | The name of the current element. | | [OauthJWTXParent](#OauthJWTXParent) | The parent of the current element. | | [OAuthJWTXPath](#OAuthJWTXPath) | Provides a way to point to a specific element in the returned payload of a JWT based access token. | | [OAuthJWTXSubTree](#OAuthJWTXSubTree) | A snapshot of the current element in the document. | | [OAuthJWTXText](#OAuthJWTXText) | The text of the current element. | | [OAuthParamCount](#OAuthParamCount) | Specifies the number of additional parameters variables to include in the request. | | [OAuthParamName\[i\]](#OAuthParamName[i]) | Specifies the parameter name at the specified index. | | [OAuthParamValue\[i\]](#OAuthParamValue[i]) | Specifies the parameter value at the specified index. | | [OAuthPasswordGrantUsername](#OAuthPasswordGrantUsername) | Used in the Resource Owner Password grant type. | | [OAuthPKCEChallengeEncoding](#OAuthPKCEChallengeEncoding) | The PKCE code challenge method to use. | | [OAuthPKCEVerifier](#OAuthPKCEVerifier) | The PKCE verifier used to generate the challenge. | | [OAuthResetData](#OAuthResetData) | Determines if the Reset method applies to the OAuth settings. | | [OAuthReUseWebServer](#OAuthReUseWebServer) | Determines if the same server instance is used between requests. | | [OAuthTransferredRequest](#OAuthTransferredRequest) | The full OAuth request last sent by the client. | | [OAuthUsePKCE](#OAuthUsePKCE) | Specifies if PKCE should be used. | | [OAuthWebServerActive](#OAuthWebServerActive) | Specifies and controls whether the embedded web server is active. | | [OAuthWebServerCertStore](#OAuthWebServerCertStore) | The certificate with private key to use when SSL is enabled. | | [OAuthWebServerCertStorePassword](#OAuthWebServerCertStorePassword) | The certificate with private key to use when SSL is enabled. | | [OAuthWebServerCertStoreType](#OAuthWebServerCertStoreType) | The certificate with private key to use when SSL is enabled. | | [OAuthWebServerCertSubject](#OAuthWebServerCertSubject) | The certificate with private key to use when SSL is enabled. | | [OAuthWebServerFailedResponse](#OAuthWebServerFailedResponse) | The custom response that will be displayed to the user if authentication failed. | | [OAuthWebServerHost](#OAuthWebServerHost) | The hostname used by the embedded web server displayed in the ReturnURL. | | [OAuthWebServerPort](#OAuthWebServerPort) | The local port on which the embedded web server listens. | | [OAuthWebServerResponse](#OAuthWebServerResponse) | The custom response that will be displayed to the user. | | [OAuthWebServerSSLEnabled](#OAuthWebServerSSLEnabled) | Whether the web server requires SSL connections. | | [AcceptEncoding](#AcceptEncoding) | Used to tell the server which types of content encodings the client supports. | | [AllowHTTPCompression](#AllowHTTPCompression) | This property enables HTTP compression for receiving data. | | [AllowHTTPFallback](#AllowHTTPFallback) | Whether HTTP/2 connections are permitted to fallback to HTTP/1.1. | | [Append](#Append) | Whether to append data to LocalFile. | | [Authorization](#Authorization) | The Authorization string to be sent to the server. | | [BytesTransferred](#BytesTransferred) | Contains the number of bytes transferred in the response data. | | [ChunkSize](#ChunkSize) | Specifies the chunk size in bytes when using chunked encoding. | | [CompressHTTPRequest](#CompressHTTPRequest) | Set to true to compress the body of a PUT or POST request. | | [EncodeURL](#EncodeURL) | If set to True the URL will be encoded by the class. | | [FollowRedirects](#FollowRedirects) | Determines what happens when the server issues a redirect. | | [GetOn302Redirect](#GetOn302Redirect) | If set to True the class will perform a GET on the new location. | | [HTTP2HeadersWithoutIndexing](#HTTP2HeadersWithoutIndexing) | HTTP2 headers that should not update the dynamic header table with incremental indexing. | | [HTTPVersion](#HTTPVersion) | The version of HTTP used by the class. | | [IfModifiedSince](#IfModifiedSince) | A date determining the maximum age of the desired document. | | [KeepAlive](#KeepAlive) | Determines whether the HTTP connection is closed after completion of the request. | | [KerberosSPN](#KerberosSPN) | The Service Principal Name for the Kerberos Domain Controller. | | [LogLevel](#LogLevel) | The level of detail that is logged. | | [MaxRedirectAttempts](#MaxRedirectAttempts) | Limits the number of redirects that are followed in a request. | | [NegotiatedHTTPVersion](#NegotiatedHTTPVersion) | The negotiated HTTP version. | | [OtherHeaders](#OtherHeaders) | Other headers as determined by the user (optional). | | [ProxyAuthorization](#ProxyAuthorization) | The authorization string to be sent to the proxy server. | | [ProxyAuthScheme](#ProxyAuthScheme) | The authorization scheme to be used for the proxy. | | [ProxyPassword](#ProxyPassword) | A password if authentication is to be used for the proxy. | | [ProxyPort](#ProxyPort) | Port for the proxy server (default 80). | | [ProxyServer](#ProxyServer) | Name or IP address of a proxy server (optional). | | [ProxyUser](#ProxyUser) | A user name if authentication is to be used for the proxy. | | [SentHeaders](#SentHeaders) | The full set of headers as sent by the client. | | [StatusCode](#StatusCode) | The status code of the last response from the server. | | [StatusLine](#StatusLine) | The first line of the last response from the server. | | [TransferredData](#TransferredData) | The contents of the last response from the server. | | [TransferredDataLimit](#TransferredDataLimit) | The maximum number of incoming bytes to be stored by the class. | | [TransferredHeaders](#TransferredHeaders) | The full set of headers as received from the server. | | [TransferredRequest](#TransferredRequest) | The full request as sent by the client. | | [UseChunkedEncoding](#UseChunkedEncoding) | Enables or Disables HTTP chunked encoding for transfers. | | [UseIDNs](#UseIDNs) | Whether to encode hostnames to internationalized domain names. | | [UsePlatformHTTPClient](#UsePlatformHTTPClient) | Whether or not to use the platform HTTP client. | | [UseProxyAutoConfigURL](#UseProxyAutoConfigURL) | Whether to use a Proxy auto-config file when attempting a connection. | | [UserAgent](#UserAgent) | Information about the user agent (browser). | | [ConnectionTimeout](#ConnectionTimeout) | Sets a separate timeout value for establishing a connection. | | [FirewallAutoDetect](#FirewallAutoDetect) | Tells the class whether or not to automatically detect and use firewall system settings, if available. | | [FirewallHost](#FirewallHost) | Name or IP address of firewall (optional). | | [FirewallHTTPVersion](#FirewallHTTPVersion) | The HTTP version to be used when connecting through a tunneling proxy. | | [FirewallPassword](#FirewallPassword) | Password to be used if authentication is to be used when connecting through the firewall. | | [FirewallPort](#FirewallPort) | The TCP port for the FirewallHost;. | | [FirewallType](#FirewallType) | Determines the type of firewall to connect through. | | [FirewallUser](#FirewallUser) | A user name if authentication is to be used connecting through a firewall. | | [KeepAliveInterval](#KeepAliveInterval) | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. | | [KeepAliveTime](#KeepAliveTime) | The inactivity time in milliseconds before a TCP keep-alive packet is sent. | | [Linger](#Linger) | When set to True, connections are terminated gracefully. | | [LingerTime](#LingerTime) | Time in seconds to have the connection linger. | | [LocalHost](#LocalHost) | The name of the local host through which connections are initiated or accepted. | | [LocalPort](#LocalPort) | The port in the local host where the class binds. | | [MaxLineLength](#MaxLineLength) | The maximum amount of data to accumulate when no EOL is found. | | [MaxTransferRate](#MaxTransferRate) | The transfer rate limit in bytes per second. | | [ProxyExceptionsList](#ProxyExceptionsList) | A semicolon separated list of hosts and IPs to bypass when using a proxy. | | [TCPKeepAlive](#TCPKeepAlive) | Determines whether or not the keep alive socket option is enabled. | | [TcpNoDelay](#TcpNoDelay) | Whether or not to delay when sending packets. | | [UseIPv6](#UseIPv6) | Whether to use IPv6. | | [UseNTLMv2](#UseNTLMv2) | Whether to use NTLM V2. | | [LogSSLPackets](#LogSSLPackets) | Controls whether SSL packets are logged when using the internal security API. | | [OpenSSLCADir](#OpenSSLCADir) | The path to a directory containing CA certificates. | | [OpenSSLCAFile](#OpenSSLCAFile) | Name of the file containing the list of CA's trusted by your application. | | [OpenSSLCipherList](#OpenSSLCipherList) | A string that controls the ciphers to be used by SSL. | | [OpenSSLPrngSeedData](#OpenSSLPrngSeedData) | The data to seed the pseudo random number generator (PRNG). | | [ReuseSSLSession](#ReuseSSLSession) | Determines if the SSL session is reused. | | [SSLCACertFilePaths](#SSLCACertFilePaths) | The paths to CA certificate files on Unix/Linux. | | [SSLCACerts](#SSLCACerts) | A newline separated list of CA certificates to be included when performing an SSL handshake. | | [SSLCheckCRL](#SSLCheckCRL) | Whether to check the Certificate Revocation List for the server certificate. | | [SSLCheckOCSP](#SSLCheckOCSP) | Whether to use OCSP to check the status of the server certificate. | | [SSLCipherStrength](#SSLCipherStrength) | The minimum cipher strength used for bulk encryption. | | [SSLClientCACerts](#SSLClientCACerts) | A newline separated list of CA certificates to use during SSL client certificate validation. | | [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) | The cipher suite to be used in an SSL negotiation. | | [SSLEnabledProtocols](#SSLEnabledProtocols) | Used to enable/disable the supported security protocols. | | [SSLEnableRenegotiation](#SSLEnableRenegotiation) | Whether the renegotiation_info SSL extension is supported. | | [SSLIncludeCertChain](#SSLIncludeCertChain) | Whether the entire certificate chain is included in the SSLServerAuthentication event. | | [SSLKeyLogFile](#SSLKeyLogFile) | The location of a file where per-session secrets are written for debugging purposes. | | [SSLNegotiatedCipher](#SSLNegotiatedCipher) | Returns the negotiated cipher suite. | | [SSLNegotiatedCipherStrength](#SSLNegotiatedCipherStrength) | Returns the negotiated cipher suite strength. | | [SSLNegotiatedCipherSuite](#SSLNegotiatedCipherSuite) | Returns the negotiated cipher suite. | | [SSLNegotiatedKeyExchange](#SSLNegotiatedKeyExchange) | Returns the negotiated key exchange algorithm. | | [SSLNegotiatedKeyExchangeStrength](#SSLNegotiatedKeyExchangeStrength) | Returns the negotiated key exchange algorithm strength. | | [SSLNegotiatedVersion](#SSLNegotiatedVersion) | Returns the negotiated protocol version. | | [SSLSecurityFlags](#SSLSecurityFlags) | Flags that control certificate verification. | | [SSLServerCACerts](#SSLServerCACerts) | A newline separated list of CA certificates to use during SSL server certificate validation. | | [TLS12SignatureAlgorithms](#TLS12SignatureAlgorithms) | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. | | [TLS12SupportedGroups](#TLS12SupportedGroups) | The supported groups for ECC. | | [TLS13KeyShareGroups](#TLS13KeyShareGroups) | The groups for which to pregenerate key shares. | | [TLS13SignatureAlgorithms](#TLS13SignatureAlgorithms) | The allowed certificate signature algorithms. | | [TLS13SupportedGroups](#TLS13SupportedGroups) | The supported groups for (EC)DHE key exchange. | | [AbsoluteTimeout](#AbsoluteTimeout) | Determines whether timeouts are inactivity timeouts or absolute timeouts. | | [FirewallData](#FirewallData) | Used to send extra data to the firewall. | | [InBufferSize](#InBufferSize) | The size in bytes of the incoming queue of the socket. | | [OutBufferSize](#OutBufferSize) | The size in bytes of the outgoing queue of the socket. | | [BuildInfo](#BuildInfo) | Information about the product's build. | | [CodePage](#CodePage) | The system code page used for Unicode to Multibyte translations. | | [LicenseInfo](#LicenseInfo) | Information about the current license. | | [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. | | [ProcessIdleEvents](#ProcessIdleEvents) | Whether the class uses its internal event loop to process events when the main thread is idle. | | [SelectWaitMillis](#SelectWaitMillis) | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. | | [UseFIPSCompliantAPI](#UseFIPSCompliantAPI) | Tells the class whether or not to use FIPS certified APIs. | | [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. | # attachments_count property The number of records in the Attachment arrays. ## Syntax ```text def get_attachments_count() -> int: ... def set_attachments_count(value: int) -> None: ... attachments_count = property(get_attachments_count, set_attachments_count) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [attachment_content_type](#attachment_content_type-property) - [attachment_data](#attachment_data-property) - [attachment_event_id](#attachment_event_id-property) - [attachment_file_name](#attachment_file_name-property) - [attachment_id](#attachment_id-property) - [attachment_is_inline](#attachment_is_inline-property) - [attachment_json](#attachment_json-property) - [attachment_last_modified_date](#attachment_last_modified_date-property) - [attachment_name](#attachment_name-property) - [attachment_size](#attachment_size-property) The array indices start at *0* and end at *attachments_count - 1*. # attachment_content_type property This property contains the content type of the attachment. ## Syntax ```text def get_attachment_content_type(attachment_index: int) -> str: ... ``` ## Default Value "" ## Remarks This field contains the content type of the attachment. The *attachment_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [attachments_count](#attachments_count-property) property. This property is read-only. # attachment_data property This property contains the raw data of the attachment. ## Syntax ```text def get_attachment_data(attachment_index: int) -> bytes: ... def set_attachment_data(attachment_index: int, value: bytes) -> None: ... ``` ## Default Value "" ## Remarks This field contains the raw data of the attachment. Only after calling the RetrieveAttachment method The *attachment_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [attachments_count](#attachments_count-property) property. # attachment_event_id property This property contains the event identifier of the attachment. ## Syntax ```text def get_attachment_event_id(attachment_index: int) -> str: ... ``` ## Default Value "" ## Remarks This field contains the event identifier of the attachment. The *attachment_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [attachments_count](#attachments_count-property) property. This property is read-only. # attachment_file_name property This property contains the local file name associated with the attachment. ## Syntax ```text def get_attachment_file_name(attachment_index: int) -> str: ... def set_attachment_file_name(attachment_index: int, value: str) -> None: ... ``` ## Default Value "" ## Remarks This field contains the local file name associated with the attachment. The *attachment_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [attachments_count](#attachments_count-property) property. # attachment_id property This property contains the attachment identifier of the attachment. ## Syntax ```text def get_attachment_id(attachment_index: int) -> str: ... ``` ## Default Value "" ## Remarks This field contains the attachment identifier of the attachment. The *attachment_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [attachments_count](#attachments_count-property) property. This property is read-only. # attachment_is_inline property This property is true if the attachment is an inline attachment. ## Syntax ```text def get_attachment_is_inline(attachment_index: int) -> bool: ... def set_attachment_is_inline(attachment_index: int, value: bool) -> None: ... ``` ## Default Value FALSE ## Remarks This field is true if the attachment is an inline attachment. The *attachment_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [attachments_count](#attachments_count-property) property. # attachment_json property A JSON representation of the attachment. ## Syntax ```text def get_attachment_json(attachment_index: int) -> str: ... def set_attachment_json(attachment_index: int, value: str) -> None: ... ``` ## Default Value "" ## Remarks A JSON representation of the attachment. Change this field to set raw JSON content to send on the next update. Other fields values will be ignored in this case. The *attachment_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [attachments_count](#attachments_count-property) property. # attachment_last_modified_date property This property contains the date and time when the attachment was last modified. ## Syntax ```text def get_attachment_last_modified_date(attachment_index: int) -> str: ... def set_attachment_last_modified_date(attachment_index: int, value: str) -> None: ... ``` ## Default Value "" ## Remarks This field contains the date and time when the attachment was last modified. The *attachment_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [attachments_count](#attachments_count-property) property. # attachment_name property This property contains the name of the attachment. ## Syntax ```text def get_attachment_name(attachment_index: int) -> str: ... def set_attachment_name(attachment_index: int, value: str) -> None: ... ``` ## Default Value "" ## Remarks This field contains the name of the attachment. The *attachment_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [attachments_count](#attachments_count-property) property. # attachment_size property This property contains the size in bytes of the attachment. ## Syntax ```text def get_attachment_size(attachment_index: int) -> int: ... def set_attachment_size(attachment_index: int, value: int) -> None: ... ``` ## Default Value 0 ## Remarks This field contains the size in bytes of the attachment. The *attachment_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [attachments_count](#attachments_count-property) property. # authorization property An OAuth Authorization String. ## Syntax ```text def get_authorization() -> str: ... def set_authorization(value: str) -> None: ... authorization = property(get_authorization, set_authorization) ``` ## Default Value "" ## Remarks This property is used to specify an OAuth authorization string. Setting it is a requirement for using the component. **Example** ```text Oauth oauth = new Oauth(); oauth.ClientId = "YourClientId"; oauth.ClientSecret = "YourClientSecret"; oauth.ServerAuthURL = "https://login.microsoftonline.com/common/oauth2/v2.0/authorize"; oauth.ServerTokenURL = "https://login.microsoftonline.com/common/oauth2/v2.0/token"; oauth.AuthorizationScope = "offline_access user.read Calendars.Read Calendars.ReadWrite"; oauth.ClientProfile = OAuthClientProfiles.ocpApplication; oauth.GrantType = OauthGrantTypes.ogtAuthorizationCode; office365calendar.Authorization = oauth.GetAuthorization(); ``` # calendars_count property The number of records in the Calendar arrays. ## Syntax ```text def get_calendars_count() -> int: ... def set_calendars_count(value: int) -> None: ... calendars_count = property(get_calendars_count, set_calendars_count) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [calendar_can_edit](#calendar_can_edit-property) - [calendar_can_share](#calendar_can_share-property) - [calendar_can_view_private_items](#calendar_can_view_private_items-property) - [calendar_change_key](#calendar_change_key-property) - [calendar_color](#calendar_color-property) - [calendar_hex_color](#calendar_hex_color-property) - [calendar_id](#calendar_id-property) - [calendar_is_default_calendar](#calendar_is_default_calendar-property) - [calendar_is_removable](#calendar_is_removable-property) - [calendar_name](#calendar_name-property) - [calendar_owner](#calendar_owner-property) The array indices start at *0* and end at *calendars_count - 1*. # calendar_can_edit property true if the user can write to the calendar, false otherwise. ## Syntax ```text def get_calendar_can_edit(calendar_index: int) -> bool: ... ``` ## Default Value FALSE ## Remarks true if the user can write to the calendar, false otherwise. The *calendar_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [calendars_count](#calendars_count-property) property. This property is read-only. # calendar_can_share property true if the user has the permission to share the calendar, false otherwise. ## Syntax ```text def get_calendar_can_share(calendar_index: int) -> bool: ... ``` ## Default Value FALSE ## Remarks true if the user has the permission to share the calendar, false otherwise. The *calendar_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [calendars_count](#calendars_count-property) property. This property is read-only. # calendar_can_view_private_items property true if the user can read calendar items that have been marked private, false otherwise. ## Syntax ```text def get_calendar_can_view_private_items(calendar_index: int) -> bool: ... ``` ## Default Value FALSE ## Remarks true if the user can read calendar items that have been marked private, false otherwise. The *calendar_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [calendars_count](#calendars_count-property) property. This property is read-only. # calendar_change_key property Identifies the version of the calendar object. ## Syntax ```text def get_calendar_change_key(calendar_index: int) -> str: ... ``` ## Default Value "" ## Remarks Identifies the version of the calendar object. The *calendar_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [calendars_count](#calendars_count-property) property. This property is read-only. # calendar_color property Specifies the color theme to distinguish the calendar from other calendars in a UI. ## Syntax ```text def get_calendar_color(calendar_index: int) -> int: ... def set_calendar_color(calendar_index: int, value: int) -> None: ... ``` ## Possible Values ```text 0 # Auto1 # LightBlue2 # LightGreen3 # LightOrange4 # LightGray5 # LightYellow6 # LightTeal7 # LightPink8 # LightBrown9 # LightRed10 # MaxColor ``` ## Default Value 0 ## Remarks Specifies the color theme to distinguish the calendar from other calendars in a UI. Possible values are: - 0 (occAuto) - 1 (occLightBlue) - 2 (occLightGreen) - 3 (occLightOrange) - 4 (occLightGray) - 5 (occLightYellow) - 6 (occLightTeal) - 7 (occLightPink) - 8 (occLightBrown) - 9 (occLightRed) - 10 (occMaxColor) The *calendar_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [calendars_count](#calendars_count-property) property. # calendar_hex_color property The calendar color, expressed in a hex color code. ## Syntax ```text def get_calendar_hex_color(calendar_index: int) -> str: ... ``` ## Default Value "" ## Remarks The calendar color, expressed in a hex color code. The *calendar_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [calendars_count](#calendars_count-property) property. This property is read-only. # calendar_id property The unique identifier of the calendar. ## Syntax ```text def get_calendar_id(calendar_index: int) -> str: ... ``` ## Default Value "" ## Remarks The unique identifier of the calendar. The *calendar_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [calendars_count](#calendars_count-property) property. This property is read-only. # calendar_is_default_calendar property True if this is the default calendar where new events are created by default, false otherwise. ## Syntax ```text def get_calendar_is_default_calendar(calendar_index: int) -> bool: ... ``` ## Default Value FALSE ## Remarks True if this is the default calendar where new events are created by default, false otherwise. The *calendar_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [calendars_count](#calendars_count-property) property. This property is read-only. # calendar_is_removable property Indicates whether this user calendar can be deleted from the user mailbox. ## Syntax ```text def get_calendar_is_removable(calendar_index: int) -> bool: ... ``` ## Default Value FALSE ## Remarks Indicates whether this user calendar can be deleted from the user mailbox. The *calendar_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [calendars_count](#calendars_count-property) property. This property is read-only. # calendar_name property the calendar's name. ## Syntax ```text def get_calendar_name(calendar_index: int) -> str: ... def set_calendar_name(calendar_index: int, value: str) -> None: ... ``` ## Default Value "" ## Remarks the calendar's name The *calendar_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [calendars_count](#calendars_count-property) property. # calendar_owner property If set, this represents the user who created or added the calendar. ## Syntax ```text def get_calendar_owner(calendar_index: int) -> str: ... ``` ## Default Value "" ## Remarks If set, this represents the user who created or added the calendar. For a calendar that the user created or added, the owner property is set to the user. For a calendar shared with the user, the owner property is set to the person who shared that calendar with the user. The *calendar_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [calendars_count](#calendars_count-property) property. This property is read-only. # events_count property The number of records in the Event arrays. ## Syntax ```text def get_events_count() -> int: ... def set_events_count(value: int) -> None: ... events_count = property(get_events_count, set_events_count) ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [event_attendee_email](#event_attendee_email-property) - [event_attendee_index](#event_attendee_index-property) - [event_attendee_new_time_end](#event_attendee_new_time_end-property) - [event_attendee_new_time_end_time_zone](#event_attendee_new_time_end_time_zone-property) - [event_attendee_new_time_start](#event_attendee_new_time_start-property) - [event_attendee_new_time_start_time_zone](#event_attendee_new_time_start_time_zone-property) - [event_attendees_count](#event_attendees_count-property) - [event_attendee_status_response](#event_attendee_status_response-property) - [event_attendee_status_time](#event_attendee_status_time-property) - [event_attendee_type](#event_attendee_type-property) - [event_body](#event_body-property) - [event_body_is_html](#event_body_is_html-property) - [event_body_preview](#event_body_preview-property) - [event_calendar_id](#event_calendar_id-property) - [event_categories](#event_categories-property) - [event_change_key](#event_change_key-property) - [event_created_date_time](#event_created_date_time-property) - [event_end_date_time](#event_end_date_time-property) - [event_end_time_zone](#event_end_time_zone-property) - [event_has_attachments](#event_has_attachments-property) - [event_id](#event_id-property) - [event_importance](#event_importance-property) - [event_is_all_day](#event_is_all_day-property) - [event_is_cancelled](#event_is_cancelled-property) - [event_is_reminder_on](#event_is_reminder_on-property) - [event_json](#event_json-property) - [event_last_modified_date_time](#event_last_modified_date_time-property) - [event_original_end_time_zone](#event_original_end_time_zone-property) - [event_original_start_date_time](#event_original_start_date_time-property) - [event_original_start_time_zone](#event_original_start_time_zone-property) - [event_recur_day_of_month](#event_recur_day_of_month-property) - [event_recur_days_of_week](#event_recur_days_of_week-property) - [event_recur_end_date](#event_recur_end_date-property) - [event_recur_first_day_of_week](#event_recur_first_day_of_week-property) - [event_recur_index](#event_recur_index-property) - [event_recur_interval](#event_recur_interval-property) - [event_recur_month](#event_recur_month-property) - [event_recur_number_of_occurrences](#event_recur_number_of_occurrences-property) - [event_recur_range_type](#event_recur_range_type-property) - [event_recur_start_date](#event_recur_start_date-property) - [event_recur_time_zone](#event_recur_time_zone-property) - [event_recur_type](#event_recur_type-property) - [event_reminder_minutes_before_start](#event_reminder_minutes_before_start-property) - [event_sensitivity](#event_sensitivity-property) - [event_series_master_id](#event_series_master_id-property) - [event_show_as](#event_show_as-property) - [event_start_date_time](#event_start_date_time-property) - [event_start_time_zone](#event_start_time_zone-property) - [event_subject](#event_subject-property) - [event_type](#event_type-property) The array indices start at *0* and end at *events_count - 1*. # event_attendee_email property Attendee email address. ## Syntax ```text def get_event_attendee_email(event_index: int) -> str: ... def set_event_attendee_email(event_index: int, value: str) -> None: ... ``` ## Default Value "" ## Remarks Attendee email address. Set to empty string or null to delete. The *event_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [events_count](#events_count-property) property. # event_attendee_index property Index of attendee to get or set its properties. ## Syntax ```text def get_event_attendee_index(event_index: int) -> int: ... def set_event_attendee_index(event_index: int, value: int) -> None: ... ``` ## Default Value 0 ## Remarks Index of attendee to get or set its fields. **Example** ```csharp OCalEvent currentEvent = ocal.Events[0]; //retrieve event after creation //Set properties to update currentEvent.Subject = "Birthday party"; currentEvent.AttendeesCount = 2; //this event will have 2 attendees //Set the attendee properties for both attendees currentEvent.AttendeeIndex = 0; //set index of attendee currentEvent.AttendeeEmail = "example@example.com"; currentEvent.AttendeeIndex = 1; //set index of attendee currentEvent.AttendeeEmail = "example2@example.com"; ``` The *event_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [events_count](#events_count-property) property. # event_attendee_new_time_end property Attendee's proposed new event ending time. ## Syntax ```text def get_event_attendee_new_time_end(event_index: int) -> str: ... ``` ## Default Value "" ## Remarks Attendee's proposed new event ending time. The *event_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [events_count](#events_count-property) property. This property is read-only. # event_attendee_new_time_end_time_zone property The end time zone that was proposed by attendee. ## Syntax ```text def get_event_attendee_new_time_end_time_zone(event_index: int) -> str: ... ``` ## Default Value "" ## Remarks The end time zone that was proposed by attendee. A value of tzone://Microsoft/Custom indicates that a legacy custom time zone was set in desktop Outlook. The *event_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [events_count](#events_count-property) property. This property is read-only. # event_attendee_new_time_start property Attendee's new event starting time. ## Syntax ```text def get_event_attendee_new_time_start(event_index: int) -> str: ... ``` ## Default Value "" ## Remarks Attendee's new event starting time. The *event_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [events_count](#events_count-property) property. This property is read-only. # event_attendee_new_time_start_time_zone property The start time zone that was proposed by attendee. ## Syntax ```text def get_event_attendee_new_time_start_time_zone(event_index: int) -> str: ... ``` ## Default Value "" ## Remarks The start time zone that was proposed by attendee. A value of tzone://Microsoft/Custom indicates that a legacy custom time zone was set in desktop Outlook. The *event_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [events_count](#events_count-property) property. This property is read-only. # event_attendees_count property When retrieving events, it indicates the number of attendees linked to the event. ## Syntax ```text def get_event_attendees_count(event_index: int) -> int: ... def set_event_attendees_count(event_index: int, value: int) -> None: ... ``` ## Default Value 0 ## Remarks When retrieving events, it indicates the number of attendees linked to the event. When updating an event, this property is set to the number of attendees the event will have. The *event_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [events_count](#events_count-property) property. # event_attendee_status_response property The attendee's response status. ## Syntax ```text def get_event_attendee_status_response(event_index: int) -> int: ... def set_event_attendee_status_response(event_index: int, value: int) -> None: ... ``` ## Possible Values ```text 0 # None1 # Organizer2 # TentativelyAccepted3 # Accepted4 # Declined5 # NotResponded ``` ## Default Value 0 ## Remarks The attendee's response status. Possible values are: | | | | --- | --- | | 0 (oasrNone) | From organizer's perspective. This value is used when the status of an attendee is reported to the organizer of an event. | | 1 (oasrOrganizer) | Indicates the response type from the organizer's perspective. | | 2 (oasrTentativelyAccepted) | The attendee has tentatively accepted the invitation. | | 3 (oasrAccepted) | The attendee has accepted the invitation. | | 4 (oasrDeclined) | The attendee has declined the invitation. | | 5 (oasrNotResponded) | From attendee's perspective. Indicates the attendee has not responded to the event invitation. | The *event_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [events_count](#events_count-property) property. # event_attendee_status_time property The date and time when the response was returned. ## Syntax ```text def get_event_attendee_status_time(event_index: int) -> str: ... def set_event_attendee_status_time(event_index: int, value: str) -> None: ... ``` ## Default Value "" ## Remarks The date and time when the response was returned. It uses ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z The *event_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [events_count](#events_count-property) property. # event_attendee_type property The attendee type. ## Syntax ```text def get_event_attendee_type(event_index: int) -> int: ... def set_event_attendee_type(event_index: int, value: int) -> None: ... ``` ## Possible Values ```text 0 # Required1 # Optional2 # Resource ``` ## Default Value 0 ## Remarks The attendee type. Possible values are: | | | | --- | --- | | 0 (ocatRequired) | The attendee is marked as required for this event. | | 1 (ocatOptional) | The attendee is marked as optional for this event. | | 2 (ocatResource) | The attendee is marked as a resource for this event. | The *event_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [events_count](#events_count-property) property. # event_body property The body of the message associated with the event. ## Syntax ```text def get_event_body(event_index: int) -> str: ... def set_event_body(event_index: int, value: str) -> None: ... ``` ## Default Value "" ## Remarks The body of the message associated with the event. It can be in HTML or text format. The *event_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [events_count](#events_count-property) property. # event_body_is_html property Indicates the text format of the body is HTML. ## Syntax ```text def get_event_body_is_html(event_index: int) -> bool: ... def set_event_body_is_html(event_index: int, value: bool) -> None: ... ``` ## Default Value FALSE ## Remarks Indicates the text format of the body is HTML. The *event_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [events_count](#events_count-property) property. # event_body_preview property The preview of the message associated with the event. ## Syntax ```text def get_event_body_preview(event_index: int) -> str: ... def set_event_body_preview(event_index: int, value: str) -> None: ... ``` ## Default Value "" ## Remarks The preview of the message associated with the event. It is in text format. The *event_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [events_count](#events_count-property) property. # event_calendar_id property The ID of the calendar that contains the event. ## Syntax ```text def get_event_calendar_id(event_index: int) -> str: ... ``` ## Default Value "" ## Remarks The ID of the calendar that contains the event. The *event_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [events_count](#events_count-property) property. This property is read-only. # event_categories property The categories associated with the event. ## Syntax ```text def get_event_categories(event_index: int) -> str: ... def set_event_categories(event_index: int, value: str) -> None: ... ``` ## Default Value "" ## Remarks The categories associated with the event. Each category corresponds to the displayName property of an outlookCategory defined for the user. The *event_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [events_count](#events_count-property) property. # event_change_key property Identifies the version of the event object. ## Syntax ```text def get_event_change_key(event_index: int) -> str: ... ``` ## Default Value "" ## Remarks Identifies the version of the event object. The *event_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [events_count](#events_count-property) property. This property is read-only. # event_created_date_time property The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. ## Syntax ```text def get_event_created_date_time(event_index: int) -> str: ... ``` ## Default Value "" ## Remarks The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. The *event_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [events_count](#events_count-property) property. This property is read-only. # event_end_date_time property The date, time, and time zone that the event ends. ## Syntax ```text def get_event_end_date_time(event_index: int) -> str: ... def set_event_end_date_time(event_index: int, value: str) -> None: ... ``` ## Default Value "" ## Remarks The date, time, and time zone that the event ends. By default, the end time is in UTC. The *event_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [events_count](#events_count-property) property. # event_end_time_zone property The current end time zone. ## Syntax ```text def get_event_end_time_zone(event_index: int) -> str: ... def set_event_end_time_zone(event_index: int, value: str) -> None: ... ``` ## Default Value "" ## Remarks The current end time zone. A value of tzone://Microsoft/Custom indicates that a legacy custom time zone was set in desktop Outlook. The *event_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [events_count](#events_count-property) property. # event_type property The event type. ## Syntax ```text def get_event_type(event_index: int) -> int: ... ``` ## Possible Values ```text 0 # SingleInstance1 # Occurrence2 # Exception3 # SeriesMaster ``` ## Default Value 0 ## Remarks The event type. Possible values are: | | | | --- | --- | | 0 (ocetSingleInstance) | The event is a single instance. | | 1 (ocetOccurrence) | The event is a recurring event. | | 2 (ocetException) | The event is an exception type (recurring event that differs from the original recurrence pattern). | | 3 (ocetSeriesMaster) | The primary event within a recurring series. | The *event_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [events_count](#events_count-property) property. This property is read-only. # event_has_attachments property Set to true if the event has attachments. ## Syntax ```text def get_event_has_attachments(event_index: int) -> bool: ... ``` ## Default Value FALSE ## Remarks Set to true if the event has attachments. The *event_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [events_count](#events_count-property) property. This property is read-only. # event_id property The unique identifier of the event. ## Syntax ```text def get_event_id(event_index: int) -> str: ... ``` ## Default Value "" ## Remarks The unique identifier of the event. The *event_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [events_count](#events_count-property) property. This property is read-only. # event_importance property The importance of the event. ## Syntax ```text def get_event_importance(event_index: int) -> int: ... def set_event_importance(event_index: int, value: int) -> None: ... ``` ## Possible Values ```text 0 # Low1 # Normal2 # High ``` ## Default Value 0 ## Remarks The importance of the event. Possible values are: - 0 (ociLow) - 1 (ociNormal) - 2 (ociHigh) The *event_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [events_count](#events_count-property) property. # event_is_all_day property Set to true if the event lasts all day. ## Syntax ```text def get_event_is_all_day(event_index: int) -> bool: ... def set_event_is_all_day(event_index: int, value: bool) -> None: ... ``` ## Default Value FALSE ## Remarks Set to true if the event lasts all day. Setting Start and End is required when changing this value. The *event_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [events_count](#events_count-property) property. # event_is_cancelled property Set to true if the event has been canceled. ## Syntax ```text def get_event_is_cancelled(event_index: int) -> bool: ... ``` ## Default Value FALSE ## Remarks Set to true if the event has been canceled. The *event_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [events_count](#events_count-property) property. This property is read-only. # event_is_reminder_on property Set to true if an alert is set to remind the user of the event. ## Syntax ```text def get_event_is_reminder_on(event_index: int) -> bool: ... def set_event_is_reminder_on(event_index: int, value: bool) -> None: ... ``` ## Default Value FALSE ## Remarks Set to true if an alert is set to remind the user of the event. The *event_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [events_count](#events_count-property) property. # event_json property A JSON representation of the event. ## Syntax ```text def get_event_json(event_index: int) -> str: ... def set_event_json(event_index: int, value: str) -> None: ... ``` ## Default Value "" ## Remarks A JSON representation of the event. Change this field to set raw JSON content to send on the next update. Other fields values will be ignored in this case. The *event_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [events_count](#events_count-property) property. # event_last_modified_date_time property The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. ## Syntax ```text def get_event_last_modified_date_time(event_index: int) -> str: ... ``` ## Default Value "" ## Remarks The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. The *event_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [events_count](#events_count-property) property. This property is read-only. # event_original_end_time_zone property The end time zone that was set when the event was created. ## Syntax ```text def get_event_original_end_time_zone(event_index: int) -> str: ... ``` ## Default Value "" ## Remarks The end time zone that was set when the event was created. A value of tzone://Microsoft/Custom indicates that a legacy custom time zone was set in desktop Outlook. The *event_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [events_count](#events_count-property) property. This property is read-only. # event_original_start_date_time property Represents the start time of an event when it is initially created as an occurrence or exception in a recurring series. ## Syntax ```text def get_event_original_start_date_time(event_index: int) -> str: ... ``` ## Default Value "" ## Remarks Represents the start time of an event when it is initially created as an occurrence or exception in a recurring series. This property is not returned for events that are single instances. The *event_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [events_count](#events_count-property) property. This property is read-only. # event_original_start_time_zone property The start time zone that was set when the event was created. ## Syntax ```text def get_event_original_start_time_zone(event_index: int) -> str: ... ``` ## Default Value "" ## Remarks The start time zone that was set when the event was created. A value of tzone://Microsoft/Custom indicates that a legacy custom time zone was set in desktop Outlook. The *event_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [events_count](#events_count-property) property. This property is read-only. # event_recur_day_of_month property The day of the month on which the event occurs. ## Syntax ```text def get_event_recur_day_of_month(event_index: int) -> int: ... def set_event_recur_day_of_month(event_index: int, value: int) -> None: ... ``` ## Default Value 0 ## Remarks The day of the month on which the event occurs. Required if type is absoluteMonthly or absoluteYearly. The *event_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [events_count](#events_count-property) property. # event_recur_days_of_week property A space separated collection of the days of the week on which the event occurs. ## Syntax ```text def get_event_recur_days_of_week(event_index: int) -> str: ... def set_event_recur_days_of_week(event_index: int, value: str) -> None: ... ``` ## Default Value "" ## Remarks A space separated collection of the days of the week on which the event occurs. The possible values are: sunday, monday, tuesday, wednesday, thursday, friday, saturday. If type is relativeMonthly or relativeYearly, and daysOfWeek specifies more than one day, the event falls on the first day that satisfies the pattern. Required if type is weekly, relativeMonthly, or relativeYearly. The *event_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [events_count](#events_count-property) property. # event_recur_end_date property The date to stop applying the recurrence pattern. ## Syntax ```text def get_event_recur_end_date(event_index: int) -> str: ... def set_event_recur_end_date(event_index: int, value: str) -> None: ... ``` ## Default Value "" ## Remarks The date to stop applying the recurrence pattern. Depending on the recurrence pattern of the event, the last occurrence of the meeting may not be this date. Required if type is endDate. The *event_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [events_count](#events_count-property) property. # event_recur_first_day_of_week property The first day of the week. ## Syntax ```text def get_event_recur_first_day_of_week(event_index: int) -> str: ... def set_event_recur_first_day_of_week(event_index: int, value: str) -> None: ... ``` ## Default Value "" ## Remarks The first day of the week. The possible values are: sunday, monday, tuesday, wednesday, thursday, friday, saturday. Default is sunday. Required if type is weekly. The *event_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [events_count](#events_count-property) property. # event_recur_index property Specifies on which instance of the allowed days specified in daysOfWeek the event occurs, counted from the first instance in the month. ## Syntax ```text def get_event_recur_index(event_index: int) -> str: ... def set_event_recur_index(event_index: int, value: str) -> None: ... ``` ## Default Value "" ## Remarks Specifies on which instance of the allowed days specified in daysOfWeek the event occurs, counted from the first instance in the month. The possible values are: first, second, third, fourth, last. Default is first. Optional and used if type is relativeMonthly or relativeYearly. The *event_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [events_count](#events_count-property) property. # event_recur_interval property The number of units between occurrences, where units can be in days, weeks, months, or years, depending on the type. ## Syntax ```text def get_event_recur_interval(event_index: int) -> int: ... def set_event_recur_interval(event_index: int, value: int) -> None: ... ``` ## Default Value 0 ## Remarks The number of units between occurrences, where units can be in days, weeks, months, or years, depending on the type. Required. Set to 0 to disable recurrence. The *event_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [events_count](#events_count-property) property. # event_recur_month property The month in which the event occurs. ## Syntax ```text def get_event_recur_month(event_index: int) -> int: ... def set_event_recur_month(event_index: int, value: int) -> None: ... ``` ## Default Value 0 ## Remarks The month in which the event occurs. This is a number from 1 to 12. The *event_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [events_count](#events_count-property) property. # event_recur_number_of_occurrences property The number of times to repeat the event. ## Syntax ```text def get_event_recur_number_of_occurrences(event_index: int) -> int: ... def set_event_recur_number_of_occurrences(event_index: int, value: int) -> None: ... ``` ## Default Value 0 ## Remarks The number of times to repeat the event. Required and must be positive if type is numbered. The *event_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [events_count](#events_count-property) property. # event_recur_range_type property The recurrence range. ## Syntax ```text def get_event_recur_range_type(event_index: int) -> int: ... def set_event_recur_range_type(event_index: int, value: int) -> None: ... ``` ## Possible Values ```text 0 # EndDate1 # NoEnd2 # Numbered ``` ## Default Value 0 ## Remarks The recurrence range. Possible values are: - 0 (ocrrtEndDate) - 1 (ocrrtNoEnd) - 2 (ocrrtNumbered) The *event_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [events_count](#events_count-property) property. # event_recur_start_date property The date to start applying the recurrence pattern. ## Syntax ```text def get_event_recur_start_date(event_index: int) -> str: ... def set_event_recur_start_date(event_index: int, value: str) -> None: ... ``` ## Default Value "" ## Remarks The date to start applying the recurrence pattern. The first occurrence of the meeting may be this date or later, depending on the recurrence pattern of the event. Must be the same value as the start property of the recurring event. Required. The *event_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [events_count](#events_count-property) property. # event_recur_time_zone property Time zone for the startDate and endDate properties. ## Syntax ```text def get_event_recur_time_zone(event_index: int) -> str: ... def set_event_recur_time_zone(event_index: int, value: str) -> None: ... ``` ## Default Value "" ## Remarks Time zone for the startDate and endDate properties. Optional. If not specified, the time zone of the event is used. The *event_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [events_count](#events_count-property) property. # event_recur_type property The recurrence pattern type Possible values are: 0 (ocrtDaily) 1 (ocrtWeekly) 2 (ocrtAbsoluteMonthly) 3 (ocrtRelativeMonthly) 4 (ocrtAbsoluteYearly) 5 (ocrtRelativeYearly) . ## Syntax ```text def get_event_recur_type(event_index: int) -> int: ... def set_event_recur_type(event_index: int, value: int) -> None: ... ``` ## Possible Values ```text 0 # Daily1 # Weekly2 # AbsoluteMonthly3 # RelativeMonthly4 # AbsoluteYearly5 # RelativeYearly ``` ## Default Value 0 ## Remarks The recurrence pattern type Possible values are: - 0 (ocrtDaily) - 1 (ocrtWeekly) - 2 (ocrtAbsoluteMonthly) - 3 (ocrtRelativeMonthly) - 4 (ocrtAbsoluteYearly) - 5 (ocrtRelativeYearly) The *event_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [events_count](#events_count-property) property. # event_reminder_minutes_before_start property The number of minutes before the event start time that the reminder alert occurs. ## Syntax ```text def get_event_reminder_minutes_before_start(event_index: int) -> int: ... def set_event_reminder_minutes_before_start(event_index: int, value: int) -> None: ... ``` ## Default Value 0 ## Remarks The number of minutes before the event start time that the reminder alert occurs. The *event_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [events_count](#events_count-property) property. # event_sensitivity property The event sensitivity Possible values are: 0 (ocsNormal) 1 (ocsPersonal) 2 (ocsPrivate) 3 (ocsConfidential) . ## Syntax ```text def get_event_sensitivity(event_index: int) -> int: ... def set_event_sensitivity(event_index: int, value: int) -> None: ... ``` ## Possible Values ```text 0 # Normal1 # Personal2 # Private3 # Confidential ``` ## Default Value 0 ## Remarks The event sensitivity Possible values are: - 0 (ocsNormal) - 1 (ocsPersonal) - 2 (ocsPrivate) - 3 (ocsConfidential) The *event_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [events_count](#events_count-property) property. # event_series_master_id property The ID for the recurring series master item, if this event is part of a recurring series. ## Syntax ```text def get_event_series_master_id(event_index: int) -> str: ... ``` ## Default Value "" ## Remarks The ID for the recurring series master item, if this event is part of a recurring series. The *event_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [events_count](#events_count-property) property. This property is read-only. # event_show_as property The status to show. ## Syntax ```text def get_event_show_as(event_index: int) -> int: ... def set_event_show_as(event_index: int, value: int) -> None: ... ``` ## Possible Values ```text 0 # Free1 # Tentative2 # Busy3 # OOF4 # WorkingElsewhere5 # Unknown ``` ## Default Value 0 ## Remarks The status to show. Possible values are: - 0 (ocsaFree) - 1 (ocsaTentative) - 2 (ocsaBusy) - 3 (ocsaOOF) - 4 (ocsaWorkingElsewhere) - 5 (ocsaUnknown) The *event_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [events_count](#events_count-property) property. # event_start_date_time property The start date, time, and time zone of the event. ## Syntax ```text def get_event_start_date_time(event_index: int) -> str: ... def set_event_start_date_time(event_index: int, value: str) -> None: ... ``` ## Default Value "" ## Remarks The start date, time, and time zone of the event. By default, the start time is in UTC. The *event_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [events_count](#events_count-property) property. # event_start_time_zone property The current start time zone. ## Syntax ```text def get_event_start_time_zone(event_index: int) -> str: ... def set_event_start_time_zone(event_index: int, value: str) -> None: ... ``` ## Default Value "" ## Remarks The current start time zone. A value of tzone://Microsoft/Custom indicates that a legacy custom time zone was set in desktop Outlook. The *event_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [events_count](#events_count-property) property. # event_subject property The text of the event's subject line. ## Syntax ```text def get_event_subject(event_index: int) -> str: ... def set_event_subject(event_index: int, value: str) -> None: ... ``` ## Default Value "" ## Remarks The text of the event's subject line. The *event_index* parameter specifies the index of the item in the array. The size of the array is controlled by the [events_count](#events_count-property) property. # firewall_auto_detect property Whether to automatically detect and use firewall system settings, if available. ## Syntax ```text def get_firewall_auto_detect() -> bool: ... def set_firewall_auto_detect(value: bool) -> None: ... firewall_auto_detect = property(get_firewall_auto_detect, set_firewall_auto_detect) ``` ## Default Value FALSE ## Remarks Whether to automatically detect and use firewall system settings, if available. # firewall_host property The name or IP address of the firewall (optional). ## Syntax ```text def get_firewall_host() -> str: ... def set_firewall_host(value: str) -> None: ... firewall_host = property(get_firewall_host, set_firewall_host) ``` ## Default Value "" ## Remarks The name or IP address of the firewall (optional). If a [firewall_host](#firewall_host-property) is given, the requested connections will be authenticated through the specified firewall when connecting. If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class fails with an error. # firewall_password property A password if authentication is to be used when connecting through the firewall. ## Syntax ```text def get_firewall_password() -> str: ... def set_firewall_password(value: str) -> None: ... firewall_password = property(get_firewall_password, set_firewall_password) ``` ## Default Value "" ## Remarks A password if authentication is to be used when connecting through the firewall. If [firewall_host](#firewall_host-property) is specified, the [firewall_user](#firewall_user-property) and [firewall_password](#firewall_password-property) properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error. # firewall_port property The Transmission Control Protocol (TCP) port for the firewall Host . ## Syntax ```text def get_firewall_port() -> int: ... def set_firewall_port(value: int) -> None: ... firewall_port = property(get_firewall_port, set_firewall_port) ``` ## Default Value 0 ## Remarks The Transmission Control Protocol (TCP) port for the firewall [firewall_host](#firewall_host-property). See the description of the [firewall_host](#firewall_host-property) property for details. NOTE: This property is set automatically when [firewall_type](#Office365Calendars_p_FirewallFirewallType) is set to a valid value. See the description of the [firewall_type](#Office365Calendars_p_FirewallFirewallType) property for details. # firewall_type property The type of firewall to connect through. ## Syntax ```text def get_firewall_type() -> int: ... def set_firewall_type(value: int) -> None: ... firewall_type = property(get_firewall_type, set_firewall_type) ``` ## Possible Values ```text 0 # None1 # Tunnel2 # SOCKS43 # SOCKS510 # SOCKS4A ``` ## Default Value 0 ## Remarks 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](#firewall_port-property) is set to 80. | | fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. [firewall_port](#firewall_port-property) is set to 1080. | | fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. [firewall_port](#firewall_port-property) is set to 1080. | | fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. [firewall_port](#firewall_port-property) is set to 1080. | # firewall_user property A username if authentication is to be used when connecting through a firewall. ## Syntax ```text def get_firewall_user() -> str: ... def set_firewall_user(value: str) -> None: ... firewall_user = property(get_firewall_user, set_firewall_user) ``` ## Default Value "" ## Remarks A username if authentication is to be used when connecting through a firewall. If [firewall_host](#firewall_host-property) is specified, this property and the [firewall_password](#firewall_password-property) property are used to connect and authenticate to the given [Firewall](#Type_Firewall). If the authentication fails, the class fails with an error. # list_events_marker property The page marker for listing events. ## Syntax ```text def get_list_events_marker() -> str: ... def set_list_events_marker(value: str) -> None: ... list_events_marker = property(get_list_events_marker, set_list_events_marker) ``` ## Default Value "" ## Remarks This property is populated if there are still unlisted events after [list_events](#list_events-method) is called. It contains the nextLink that will be included as an OData parameter if [list_events](#list_events-method) is called again. This will cause the next page of events to be listed and added to the end of the events collection. **Example (List All Events in a Calendar): ** ```text do { office365.ListEvents(calendarId); } while (office365.ListEventsMarker.Length > 0); ``` # o_auth_access_token property The access token returned by the authorization server. ## Syntax ```text def get_o_auth_access_token() -> str: ... def set_o_auth_access_token(value: str) -> None: ... o_auth_access_token = property(get_o_auth_access_token, set_o_auth_access_token) ``` ## Default Value "" ## Remarks The access token returned by the authorization server. This is set when the class makes a request to the token server. # o_auth_authorization_code property The authorization code that is exchanged for an access token. ## Syntax ```text def get_o_auth_authorization_code() -> str: ... def set_o_auth_authorization_code(value: str) -> None: ... o_auth_authorization_code = property(get_o_auth_authorization_code, set_o_auth_authorization_code) ``` ## Default Value "" ## Remarks The authorization code that is exchanged for an access token. This is required to be set when the o_auth_client_profile property is set to the Web profile. Otherwise, this field is for information purposes only. # o_auth_authorization_scope property The scope request or response parameter used during authorization. ## Syntax ```text def get_o_auth_authorization_scope() -> str: ... def set_o_auth_authorization_scope(value: str) -> None: ... o_auth_authorization_scope = property(get_o_auth_authorization_scope, set_o_auth_authorization_scope) ``` ## Default Value "" ## Remarks The scope request or response parameter used during authorization. # o_auth_client_id property The id of the client assigned when registering the application. ## Syntax ```text def get_o_auth_client_id() -> str: ... def set_o_auth_client_id(value: str) -> None: ... o_auth_client_id = property(get_o_auth_client_id, set_o_auth_client_id) ``` ## Default Value "" ## Remarks The id of the client assigned when registering the application. # o_auth_client_profile property The type of client that is requesting authorization. ## Syntax ```text def get_o_auth_client_profile() -> int: ... def set_o_auth_client_profile(value: int) -> None: ... o_auth_client_profile = property(get_o_auth_client_profile, set_o_auth_client_profile) ``` ## Possible Values ```text 0 # Application1 # Web ``` ## Default Value 0 ## Remarks The type of client that is requesting authorization. See the introduction section for more information. Possible values are: | | | | --- | --- | | 0 (cocpApplication - Default) | The application profile is applicable to applications that are run by the user directly. For instance a windows form application would use the application profile. To authorize your application (client) using the application profile see the introduction section. | | 1 (cocpWeb) | The Web profile is applicable to applications that are run on the server side where the user uses the application from a web browser. To authorize your application (client) using this profile follow see the introduction section. | # o_auth_client_secret property The secret value for the client assigned when registering the application. ## Syntax ```text def get_o_auth_client_secret() -> str: ... def set_o_auth_client_secret(value: str) -> None: ... o_auth_client_secret = property(get_o_auth_client_secret, set_o_auth_client_secret) ``` ## Default Value "" ## Remarks The secret value for the client assigned when registering the application. # o_auth_grant_type property The OAuth grant type used to acquire an OAuth access token. ## Syntax ```text def get_o_auth_grant_type() -> int: ... def set_o_auth_grant_type(value: int) -> None: ... o_auth_grant_type = property(get_o_auth_grant_type, set_o_auth_grant_type) ``` ## Possible Values ```text 0 # AuthorizationCode1 # Implicit2 # Password3 # ClientCredentials ``` ## Default Value 0 ## Remarks The OAuth grant type used to acquire an OAuth access token. See the introduction section for more information. Possible values are: | | | | --- | --- | | 0 (cogtAuthorizationCode - Default) | Authorization Code grant type | | 1 (cogtImplicit) | Implicit grant type | | 2 (cogtPassword) | Resource Owner Password Credentials grant type | | 3 (cogtClientCredentials) | Client Credentials grant type | # o_auth_refresh_token property Specifies the refresh token received from or sent to the authorization server. ## Syntax ```text def get_o_auth_refresh_token() -> str: ... def set_o_auth_refresh_token(value: str) -> None: ... o_auth_refresh_token = property(get_o_auth_refresh_token, set_o_auth_refresh_token) ``` ## Default Value "" ## Remarks Specifies the refresh token received from or sent to the authorization server. This property is set automatically if a refresh token is retrieved from the token server. If the OAuthAutomaticRefresh configuration setting is set to true, and the o_auth_grant_type property is set to a grant that can use refresh tokens. # o_auth_request_refresh_token property Specifies whether the class will request a refresh token during authorization. ## Syntax ```text def get_o_auth_request_refresh_token() -> bool: ... def set_o_auth_request_refresh_token(value: bool) -> None: ... o_auth_request_refresh_token = property(get_o_auth_request_refresh_token, set_o_auth_request_refresh_token) ``` ## Default Value TRUE ## Remarks Specifies whether the class will request a refresh token during authorization. By default, this value is *True*. When *True*, the class will automatically add the necessary scopes or parameters to obtain a refresh token. When *False*, this property will have no effect. If the necessary scopes or parameters are specified manually, a refresh token can still be obtained. NOTE: This property is only applicable when the o_auth_grant_type property is set to *cogtAuthorizationCode*. # o_auth_return_url property The URL where the user (browser) returns after authenticating. ## Syntax ```text def get_o_auth_return_url() -> str: ... def set_o_auth_return_url(value: str) -> None: ... o_auth_return_url = property(get_o_auth_return_url, set_o_auth_return_url) ``` ## Default Value "" ## Remarks The URL where the user (browser) returns after authenticating. This property is mapped to the *redirect_uri* parameter when making a request to the authorization server. Typically, this is automatically set by the class when using the embedded web server. If the OAuthWebServerPort or OAuthWebServerHost configuration settings is set, then this property should be set to match. If using the Web client profile, this should be set to the place where the authorization code will be parsed out of the response after the user finishes authorizing. # o_auth_server_auth_url property The URL of the authorization server. ## Syntax ```text def get_o_auth_server_auth_url() -> str: ... def set_o_auth_server_auth_url(value: str) -> None: ... o_auth_server_auth_url = property(get_o_auth_server_auth_url, set_o_auth_server_auth_url) ``` ## Default Value "" ## Remarks The URL of the authorization server. # o_auth_server_token_url property The URL of the token server used to obtain the access token. ## Syntax ```text def get_o_auth_server_token_url() -> str: ... def set_o_auth_server_token_url(value: str) -> None: ... o_auth_server_token_url = property(get_o_auth_server_token_url, set_o_auth_server_token_url) ``` ## Default Value "" ## Remarks The URL of the token server used to obtain the access token. # o_auth_timeout property The amount of time (in seconds) the class will wait for a response from the browser in the LaunchBrowser event. ## Syntax ```text def get_o_auth_timeout() -> int: ... def set_o_auth_timeout(value: int) -> None: ... o_auth_timeout = property(get_o_auth_timeout, set_o_auth_timeout) ``` ## Default Value 60 ## Remarks The amount of time (in seconds) the component will wait for a response from the browser in the on_launch_browser event. The default value is 60. # o_auth_web_auth_url property The URL to which the user should be re-directed for authorization. ## Syntax ```text def get_o_auth_web_auth_url() -> str: ... o_auth_web_auth_url = property(get_o_auth_web_auth_url, None) ``` ## Default Value "" ## Remarks The URL to which the user should be re-directed for authorization. This field is used to get the URL that the user should be redirected to when using the Web client profile. See introduction section for more information. This property is read-only. # proxy_auth_scheme property The type of authorization to perform when connecting to the proxy. ## Syntax ```text 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) ``` ## Possible Values ```text 0 # Basic1 # Digest2 # Proprietary3 # None4 # Ntlm5 # Negotiate ``` ## Default Value 0 ## Remarks The type of authorization to perform when connecting to the proxy. This is used only when the [proxy_user](#proxy_user-property) and [proxy_password](#proxy_password-property) properties are set. [proxy_auth_scheme](#proxy_auth_scheme-property) should be set to authNone (3) when no authentication is expected. By default, [proxy_auth_scheme](#proxy_auth_scheme-property) is authBasic (0), and if the [proxy_user](#proxy_user-property) and [proxy_password](#proxy_password-property) properties are set, the class will attempt basic authentication. If [proxy_auth_scheme](#proxy_auth_scheme-property) is set to authDigest (1), digest authentication will be attempted instead. If [proxy_auth_scheme](#proxy_auth_scheme-property) 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](#proxy_auth_scheme-property) is set to authNtlm (4), NTLM authentication will be used. For security reasons, setting this property will clear the values of [proxy_user](#proxy_user-property) and [proxy_password](#proxy_password-property). # proxy_auto_detect property Whether to automatically detect and use proxy system settings, if available. ## Syntax ```text def get_proxy_auto_detect() -> bool: ... def set_proxy_auto_detect(value: bool) -> None: ... proxy_auto_detect = property(get_proxy_auto_detect, set_proxy_auto_detect) ``` ## Default Value FALSE ## Remarks Whether to automatically detect and use proxy system settings, if available. The default value is *False*. # proxy_password property A password if authentication is to be used for the proxy. ## Syntax ```text def get_proxy_password() -> str: ... def set_proxy_password(value: str) -> None: ... proxy_password = property(get_proxy_password, set_proxy_password) ``` ## Default Value "" ## Remarks A password if authentication is to be used for the proxy. If [proxy_auth_scheme](#proxy_auth_scheme-property) is set to Basic Authentication, the [proxy_user](#proxy_user-property) and [proxy_password](#proxy_password-property) properties are Base64 encoded and the proxy authentication token will be generated in the form *Basic [encoded-user-password]*. If [proxy_auth_scheme](#proxy_auth_scheme-property) is set to Digest Authentication, the [proxy_user](#proxy_user-property) and [proxy_password](#proxy_password-property) properties are used to respond to the Digest Authentication challenge from the server. If [proxy_auth_scheme](#proxy_auth_scheme-property) is set to NTLM Authentication, the [proxy_user](#proxy_user-property) and [proxy_password](#proxy_password-property) properties are used to authenticate through NTLM negotiation. # proxy_port property The Transmission Control Protocol (TCP) port for the proxy Server (default 80). ## Syntax ```text def get_proxy_port() -> int: ... def set_proxy_port(value: int) -> None: ... proxy_port = property(get_proxy_port, set_proxy_port) ``` ## Default Value 80 ## Remarks The Transmission Control Protocol (TCP) port for the proxy [proxy_server](#proxy_server-property) (default 80). See the description of the [proxy_server](#proxy_server-property) 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 ```text 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](#proxy_server-property) is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. If the [proxy_server](#proxy_server-property) property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the [proxy_server](#proxy_server-property) property is set to the corresponding address. If the search is not successful, an error is returned. # proxy_ssl property When to use a Secure Sockets Layer (SSL) for the connection to the proxy. ## Syntax ```text def get_proxy_ssl() -> int: ... def set_proxy_ssl(value: int) -> None: ... proxy_ssl = property(get_proxy_ssl, set_proxy_ssl) ``` ## Possible Values ```text 0 # Automatic1 # Always2 # Never3 # Tunnel ``` ## Default Value 0 ## Remarks 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 A username if authentication is to be used for the proxy. ## Syntax ```text def get_proxy_user() -> str: ... def set_proxy_user(value: str) -> None: ... proxy_user = property(get_proxy_user, set_proxy_user) ``` ## Default Value "" ## Remarks A username if authentication is to be used for the proxy. If [proxy_auth_scheme](#proxy_auth_scheme-property) is set to Basic Authentication, the [proxy_user](#proxy_user-property) and [proxy_password](#proxy_password-property) properties are Base64 encoded and the proxy authentication token will be generated in the form *Basic [encoded-user-password]*. If [proxy_auth_scheme](#proxy_auth_scheme-property) is set to Digest Authentication, the [proxy_user](#proxy_user-property) and [proxy_password](#proxy_password-property) properties are used to respond to the Digest Authentication challenge from the server. If [proxy_auth_scheme](#proxy_auth_scheme-property) is set to NTLM Authentication, the [proxy_user](#proxy_user-property) and [proxy_password](#proxy_password-property) properties are used to authenticate through NTLM negotiation. # ssl_accept_server_cert_effective_date property The date on which this certificate becomes valid. ## Syntax ```text def get_ssl_accept_server_cert_effective_date() -> str: ... ssl_accept_server_cert_effective_date = property(get_ssl_accept_server_cert_effective_date, None) ``` ## Default Value "" ## Remarks The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2000 15:00:00. This property is read-only. # ssl_accept_server_cert_encoded property The certificate (PEM/Base64 encoded). ## Syntax ```text def get_ssl_accept_server_cert_encoded() -> bytes: ... def set_ssl_accept_server_cert_encoded(value: bytes) -> None: ... ssl_accept_server_cert_encoded = property(get_ssl_accept_server_cert_encoded, set_ssl_accept_server_cert_encoded) ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property) and [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property) properties also may be used to specify a certificate. When [ssl_accept_server_cert_encoded](#ssl_accept_server_cert_encoded-property) is set, a search is initiated in the current [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property) for the private key of the certificate. If the key is found, [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property) is updated to reflect the full subject of the selected certificate; otherwise, [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property) is set to an empty string. # ssl_accept_server_cert_expiration_date property The date on which the certificate expires. ## Syntax ```text def get_ssl_accept_server_cert_expiration_date() -> str: ... ssl_accept_server_cert_expiration_date = property(get_ssl_accept_server_cert_expiration_date, None) ``` ## Default Value "" ## Remarks The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2001 15:00:00. This property is read-only. # ssl_accept_server_cert_extended_key_usage property A comma-delimited list of extended key usage identifiers. ## Syntax ```text def get_ssl_accept_server_cert_extended_key_usage() -> str: ... ssl_accept_server_cert_extended_key_usage = property(get_ssl_accept_server_cert_extended_key_usage, None) ``` ## Default Value "" ## Remarks A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). This property is read-only. # ssl_accept_server_cert_fingerprint property The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax ```text def get_ssl_accept_server_cert_fingerprint() -> str: ... ssl_accept_server_cert_fingerprint = property(get_ssl_accept_server_cert_fingerprint, None) ``` ## Default Value "" ## Remarks The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02* This property is read-only. # ssl_accept_server_cert_fingerprint_sha1 property The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax ```text def get_ssl_accept_server_cert_fingerprint_sha1() -> str: ... ssl_accept_server_cert_fingerprint_sha1 = property(get_ssl_accept_server_cert_fingerprint_sha1, None) ``` ## Default Value "" ## Remarks The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84* This property is read-only. # ssl_accept_server_cert_fingerprint_sha256 property The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax ```text def get_ssl_accept_server_cert_fingerprint_sha256() -> str: ... ssl_accept_server_cert_fingerprint_sha256 = property(get_ssl_accept_server_cert_fingerprint_sha256, None) ``` ## Default Value "" ## Remarks The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53* This property is read-only. # ssl_accept_server_cert_issuer property The issuer of the certificate. ## Syntax ```text def get_ssl_accept_server_cert_issuer() -> str: ... ssl_accept_server_cert_issuer = property(get_ssl_accept_server_cert_issuer, None) ``` ## Default Value "" ## Remarks The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate. This property is read-only. # ssl_accept_server_cert_private_key property The private key of the certificate (if available). ## Syntax ```text def get_ssl_accept_server_cert_private_key() -> str: ... ssl_accept_server_cert_private_key = property(get_ssl_accept_server_cert_private_key, None) ``` ## Default Value "" ## Remarks The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [ssl_accept_server_cert_private_key](#ssl_accept_server_cert_private_key-property) may be available but not exportable. In this case, [ssl_accept_server_cert_private_key](#ssl_accept_server_cert_private_key-property) returns an empty string. This property is read-only. # ssl_accept_server_cert_private_key_available property Whether a PrivateKey is available for the selected certificate. ## Syntax ```text def get_ssl_accept_server_cert_private_key_available() -> bool: ... ssl_accept_server_cert_private_key_available = property(get_ssl_accept_server_cert_private_key_available, None) ``` ## Default Value FALSE ## Remarks Whether a [ssl_accept_server_cert_private_key](#ssl_accept_server_cert_private_key-property) is available for the selected certificate. If [ssl_accept_server_cert_private_key_available](#ssl_accept_server_cert_private_key_available-property) is True, the certificate may be used for authentication purposes (e.g., server authentication). This property is read-only. # ssl_accept_server_cert_private_key_container property The name of the PrivateKey container for the certificate (if available). ## Syntax ```text def get_ssl_accept_server_cert_private_key_container() -> str: ... ssl_accept_server_cert_private_key_container = property(get_ssl_accept_server_cert_private_key_container, None) ``` ## Default Value "" ## Remarks The name of the [ssl_accept_server_cert_private_key](#ssl_accept_server_cert_private_key-property) container for the certificate (if available). This functionality is available only on Windows platforms. This property is read-only. # ssl_accept_server_cert_public_key property The public key of the certificate. ## Syntax ```text def get_ssl_accept_server_cert_public_key() -> str: ... ssl_accept_server_cert_public_key = property(get_ssl_accept_server_cert_public_key, None) ``` ## Default Value "" ## Remarks The public key of the certificate. The key is provided as PEM/Base64-encoded data. This property is read-only. # ssl_accept_server_cert_public_key_algorithm property The textual description of the certificate's public key algorithm. ## Syntax ```text def get_ssl_accept_server_cert_public_key_algorithm() -> str: ... ssl_accept_server_cert_public_key_algorithm = property(get_ssl_accept_server_cert_public_key_algorithm, None) ``` ## Default Value "" ## Remarks The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm. This property is read-only. # ssl_accept_server_cert_public_key_length property The length of the certificate's public key (in bits). ## Syntax ```text def get_ssl_accept_server_cert_public_key_length() -> int: ... ssl_accept_server_cert_public_key_length = property(get_ssl_accept_server_cert_public_key_length, None) ``` ## Default Value 0 ## Remarks The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. This property is read-only. # ssl_accept_server_cert_serial_number property The serial number of the certificate encoded as a string. ## Syntax ```text def get_ssl_accept_server_cert_serial_number() -> str: ... ssl_accept_server_cert_serial_number = property(get_ssl_accept_server_cert_serial_number, None) ``` ## Default Value "" ## Remarks The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number. This property is read-only. # ssl_accept_server_cert_signature_algorithm property The text description of the certificate's signature algorithm. ## Syntax ```text def get_ssl_accept_server_cert_signature_algorithm() -> str: ... ssl_accept_server_cert_signature_algorithm = property(get_ssl_accept_server_cert_signature_algorithm, None) ``` ## Default Value "" ## Remarks The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm. This property is read-only. # ssl_accept_server_cert_store property The name of the certificate store for the client certificate. ## Syntax ```text def get_ssl_accept_server_cert_store() -> bytes: ... def set_ssl_accept_server_cert_store(value: bytes) -> None: ... ssl_accept_server_cert_store = property(get_ssl_accept_server_cert_store, set_ssl_accept_server_cert_store) ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [ssl_accept_server_cert_store_type](#ssl_accept_server_cert_store_type-property) property denotes the type of the certificate store specified by [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property). If the store is password-protected, specify the password in [ssl_accept_server_cert_store_password](#ssl_accept_server_cert_store_password-property). [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property) is used in conjunction with the [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property) property to specify client certificates. If [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property) has a value, and [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property) or [ssl_accept_server_cert_encoded](#ssl_accept_server_cert_encoded-property) is set, a search for a certificate is initiated. Please see the [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property) property for details. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store). # ssl_accept_server_cert_store_password property If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Syntax ```text def get_ssl_accept_server_cert_store_password() -> str: ... def set_ssl_accept_server_cert_store_password(value: str) -> None: ... ssl_accept_server_cert_store_password = property(get_ssl_accept_server_cert_store_password, set_ssl_accept_server_cert_store_password) ``` ## Default Value "" ## Remarks If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. # ssl_accept_server_cert_store_type property The type of certificate store for this certificate. ## Syntax ```text def get_ssl_accept_server_cert_store_type() -> int: ... def set_ssl_accept_server_cert_store_type(value: int) -> None: ... ssl_accept_server_cert_store_type = property(get_ssl_accept_server_cert_store_type, set_ssl_accept_server_cert_store_type) ``` ## Possible Values ```text 0 # User1 # Machine2 # PFXFile3 # PFXBlob4 # JKSFile5 # JKSBlob6 # PEMKeyFile7 # PEMKeyBlob8 # PublicKeyFile9 # PublicKeyBlob10 # SSHPublicKeyBlob11 # P7BFile12 # P7BBlob13 # SSHPublicKeyFile14 # PPKFile15 # PPKBlob16 # XMLFile17 # XMLBlob18 # JWKFile19 # JWKBlob20 # SecurityKey21 # BCFKSFile22 # BCFKSBlob23 # PKCS1199 # Auto ``` ## Default Value 0 ## Remarks The type of certificate store for this certificate. The class supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the class will automatically determine the type. This property can take one of the following values: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; 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.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 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 (PKCS#12) file containing certificates. | | 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) 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 PKCS#7 file containing certificates. | | 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 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). | | 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. | | 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [ssl_accept_server_cert_store_type](#ssl_accept_server_cert_store_type-property), the full path of the PKCS#11 DLL as the [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property), and the PIN as the [ssl_accept_server_cert_store_password](#ssl_accept_server_cert_store_password-property). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) class by calling the [list_store_certificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [on_cert_list](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property) and set [ssl_accept_server_cert_store_password](#ssl_accept_server_cert_store_password-property) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 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_accept_server_cert_subject property The subject of the certificate used for client authentication. ## Syntax ```text def get_ssl_accept_server_cert_subject() -> str: ... def set_ssl_accept_server_cert_subject(value: str) -> None: ... ssl_accept_server_cert_subject = property(get_ssl_accept_server_cert_subject, set_ssl_accept_server_cert_subject) ``` ## Default Value "" ## Remarks The subject of the certificate used for client authentication. This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject. If a matching certificate is found, the property is set to the full subject of the matching certificate. If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still not found, the property is set to an empty string, and no certificate is selected. The special value "*" picks a random certificate in the certificate store. The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows: | Field | Meaning | | --- | --- | | CN | Common Name. This is commonly a hostname like www.server.com. | | O | Organization | | OU | Organizational Unit | | L | Locality | | S | State | | C | Country | | E | Email Address | If a field value contains a comma, it must be quoted. # ssl_accept_server_cert_subject_alt_names property Comma-separated lists of alternative subject names for the certificate. ## Syntax ```text def get_ssl_accept_server_cert_subject_alt_names() -> str: ... ssl_accept_server_cert_subject_alt_names = property(get_ssl_accept_server_cert_subject_alt_names, None) ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. This property is read-only. # ssl_accept_server_cert_thumbprint_md5 property The MD5 hash of the certificate. ## Syntax ```text def get_ssl_accept_server_cert_thumbprint_md5() -> str: ... ssl_accept_server_cert_thumbprint_md5 = property(get_ssl_accept_server_cert_thumbprint_md5, None) ``` ## Default Value "" ## Remarks The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. # ssl_accept_server_cert_thumbprint_sha1 property The SHA-1 hash of the certificate. ## Syntax ```text def get_ssl_accept_server_cert_thumbprint_sha1() -> str: ... ssl_accept_server_cert_thumbprint_sha1 = property(get_ssl_accept_server_cert_thumbprint_sha1, None) ``` ## Default Value "" ## Remarks The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. # ssl_accept_server_cert_thumbprint_sha256 property The SHA-256 hash of the certificate. ## Syntax ```text def get_ssl_accept_server_cert_thumbprint_sha256() -> str: ... ssl_accept_server_cert_thumbprint_sha256 = property(get_ssl_accept_server_cert_thumbprint_sha256, None) ``` ## Default Value "" ## Remarks The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. # ssl_accept_server_cert_usage property The text description of UsageFlags . ## Syntax ```text def get_ssl_accept_server_cert_usage() -> str: ... ssl_accept_server_cert_usage = property(get_ssl_accept_server_cert_usage, None) ``` ## Default Value "" ## Remarks The text description of [ssl_accept_server_cert_usage_flags](#ssl_accept_server_cert_usage_flags-property). This value will be one or more of the following strings and will be separated by commas: - Digital Signature - Non-Repudiation - Key Encipherment - Data Encipherment - Key Agreement - Certificate Signing - CRL Signing - Encipher Only If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names. This property is read-only. # ssl_accept_server_cert_usage_flags property The flags that show intended use for the certificate. ## Syntax ```text def get_ssl_accept_server_cert_usage_flags() -> int: ... ssl_accept_server_cert_usage_flags = property(get_ssl_accept_server_cert_usage_flags, None) ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [ssl_accept_server_cert_usage_flags](#ssl_accept_server_cert_usage_flags-property) is a combination of the following flags: | | | | --- | --- | | 0x80 | Digital Signature | | 0x40 | Non-Repudiation | | 0x20 | Key Encipherment | | 0x10 | Data Encipherment | | 0x08 | Key Agreement | | 0x04 | Certificate Signing | | 0x02 | CRL Signing | | 0x01 | Encipher Only | Please see the [ssl_accept_server_cert_usage](#ssl_accept_server_cert_usage-property) property for a text representation of [ssl_accept_server_cert_usage_flags](#ssl_accept_server_cert_usage_flags-property). This functionality currently is not available when the provider is OpenSSL. This property is read-only. # ssl_accept_server_cert_version property The certificate's version number. ## Syntax ```text def get_ssl_accept_server_cert_version() -> str: ... ssl_accept_server_cert_version = property(get_ssl_accept_server_cert_version, None) ``` ## Default Value "" ## Remarks The certificate's version number. The possible values are the strings "V1", "V2", and "V3". This property is read-only. # ssl_cert_effective_date property The date on which this certificate becomes valid. ## Syntax ```text def get_ssl_cert_effective_date() -> str: ... ssl_cert_effective_date = property(get_ssl_cert_effective_date, None) ``` ## Default Value "" ## Remarks The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2000 15:00:00. This property is read-only. # ssl_cert_encoded property The certificate (PEM/Base64 encoded). ## Syntax ```text def get_ssl_cert_encoded() -> bytes: ... def set_ssl_cert_encoded(value: bytes) -> None: ... ssl_cert_encoded = property(get_ssl_cert_encoded, set_ssl_cert_encoded) ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [ssl_cert_store](#ssl_cert_store-property) and [ssl_cert_subject](#ssl_cert_subject-property) properties also may be used to specify a certificate. When [ssl_cert_encoded](#ssl_cert_encoded-property) is set, a search is initiated in the current [ssl_cert_store](#ssl_cert_store-property) for the private key of the certificate. If the key is found, [ssl_cert_subject](#ssl_cert_subject-property) is updated to reflect the full subject of the selected certificate; otherwise, [ssl_cert_subject](#ssl_cert_subject-property) is set to an empty string. # ssl_cert_expiration_date property The date on which the certificate expires. ## Syntax ```text def get_ssl_cert_expiration_date() -> str: ... ssl_cert_expiration_date = property(get_ssl_cert_expiration_date, None) ``` ## Default Value "" ## Remarks The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2001 15:00:00. This property is read-only. # ssl_cert_extended_key_usage property A comma-delimited list of extended key usage identifiers. ## Syntax ```text def get_ssl_cert_extended_key_usage() -> str: ... ssl_cert_extended_key_usage = property(get_ssl_cert_extended_key_usage, None) ``` ## Default Value "" ## Remarks A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). This property is read-only. # ssl_cert_fingerprint property The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax ```text def get_ssl_cert_fingerprint() -> str: ... ssl_cert_fingerprint = property(get_ssl_cert_fingerprint, None) ``` ## Default Value "" ## Remarks The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02* This property is read-only. # ssl_cert_fingerprint_sha1 property The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax ```text def get_ssl_cert_fingerprint_sha1() -> str: ... ssl_cert_fingerprint_sha1 = property(get_ssl_cert_fingerprint_sha1, None) ``` ## Default Value "" ## Remarks The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84* This property is read-only. # ssl_cert_fingerprint_sha256 property The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax ```text def get_ssl_cert_fingerprint_sha256() -> str: ... ssl_cert_fingerprint_sha256 = property(get_ssl_cert_fingerprint_sha256, None) ``` ## Default Value "" ## Remarks The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53* This property is read-only. # ssl_cert_issuer property The issuer of the certificate. ## Syntax ```text def get_ssl_cert_issuer() -> str: ... ssl_cert_issuer = property(get_ssl_cert_issuer, None) ``` ## Default Value "" ## Remarks The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate. This property is read-only. # ssl_cert_private_key property The private key of the certificate (if available). ## Syntax ```text def get_ssl_cert_private_key() -> str: ... ssl_cert_private_key = property(get_ssl_cert_private_key, None) ``` ## Default Value "" ## Remarks The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [ssl_cert_private_key](#ssl_cert_private_key-property) may be available but not exportable. In this case, [ssl_cert_private_key](#ssl_cert_private_key-property) returns an empty string. This property is read-only. # ssl_cert_private_key_available property Whether a PrivateKey is available for the selected certificate. ## Syntax ```text def get_ssl_cert_private_key_available() -> bool: ... ssl_cert_private_key_available = property(get_ssl_cert_private_key_available, None) ``` ## Default Value FALSE ## Remarks Whether a [ssl_cert_private_key](#ssl_cert_private_key-property) is available for the selected certificate. If [ssl_cert_private_key_available](#ssl_cert_private_key_available-property) is True, the certificate may be used for authentication purposes (e.g., server authentication). This property is read-only. # ssl_cert_private_key_container property The name of the PrivateKey container for the certificate (if available). ## Syntax ```text def get_ssl_cert_private_key_container() -> str: ... ssl_cert_private_key_container = property(get_ssl_cert_private_key_container, None) ``` ## Default Value "" ## Remarks The name of the [ssl_cert_private_key](#ssl_cert_private_key-property) container for the certificate (if available). This functionality is available only on Windows platforms. This property is read-only. # ssl_cert_public_key property The public key of the certificate. ## Syntax ```text def get_ssl_cert_public_key() -> str: ... ssl_cert_public_key = property(get_ssl_cert_public_key, None) ``` ## Default Value "" ## Remarks The public key of the certificate. The key is provided as PEM/Base64-encoded data. This property is read-only. # ssl_cert_public_key_algorithm property The textual description of the certificate's public key algorithm. ## Syntax ```text def get_ssl_cert_public_key_algorithm() -> str: ... ssl_cert_public_key_algorithm = property(get_ssl_cert_public_key_algorithm, None) ``` ## Default Value "" ## Remarks The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm. This property is read-only. # ssl_cert_public_key_length property The length of the certificate's public key (in bits). ## Syntax ```text def get_ssl_cert_public_key_length() -> int: ... ssl_cert_public_key_length = property(get_ssl_cert_public_key_length, None) ``` ## Default Value 0 ## Remarks The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. This property is read-only. # ssl_cert_serial_number property The serial number of the certificate encoded as a string. ## Syntax ```text def get_ssl_cert_serial_number() -> str: ... ssl_cert_serial_number = property(get_ssl_cert_serial_number, None) ``` ## Default Value "" ## Remarks The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number. This property is read-only. # ssl_cert_signature_algorithm property The text description of the certificate's signature algorithm. ## Syntax ```text def get_ssl_cert_signature_algorithm() -> str: ... ssl_cert_signature_algorithm = property(get_ssl_cert_signature_algorithm, None) ``` ## Default Value "" ## Remarks The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm. This property is read-only. # ssl_cert_store property The name of the certificate store for the client certificate. ## Syntax ```text def get_ssl_cert_store() -> bytes: ... def set_ssl_cert_store(value: bytes) -> None: ... ssl_cert_store = property(get_ssl_cert_store, set_ssl_cert_store) ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [ssl_cert_store_type](#ssl_cert_store_type-property) property denotes the type of the certificate store specified by [ssl_cert_store](#ssl_cert_store-property). If the store is password-protected, specify the password in [ssl_cert_store_password](#ssl_cert_store_password-property). [ssl_cert_store](#ssl_cert_store-property) is used in conjunction with the [ssl_cert_subject](#ssl_cert_subject-property) property to specify client certificates. If [ssl_cert_store](#ssl_cert_store-property) has a value, and [ssl_cert_subject](#ssl_cert_subject-property) or [ssl_cert_encoded](#ssl_cert_encoded-property) is set, a search for a certificate is initiated. Please see the [ssl_cert_subject](#ssl_cert_subject-property) property for details. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store). # ssl_cert_store_password property If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Syntax ```text def get_ssl_cert_store_password() -> str: ... def set_ssl_cert_store_password(value: str) -> None: ... ssl_cert_store_password = property(get_ssl_cert_store_password, set_ssl_cert_store_password) ``` ## Default Value "" ## Remarks If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. # ssl_cert_store_type property The type of certificate store for this certificate. ## Syntax ```text 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) ``` ## Possible Values ```text 0 # User1 # Machine2 # PFXFile3 # PFXBlob4 # JKSFile5 # JKSBlob6 # PEMKeyFile7 # PEMKeyBlob8 # PublicKeyFile9 # PublicKeyBlob10 # SSHPublicKeyBlob11 # P7BFile12 # P7BBlob13 # SSHPublicKeyFile14 # PPKFile15 # PPKBlob16 # XMLFile17 # XMLBlob18 # JWKFile19 # JWKBlob20 # SecurityKey21 # BCFKSFile22 # BCFKSBlob23 # PKCS1199 # Auto ``` ## Default Value 0 ## Remarks The type of certificate store for this certificate. The class supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the class will automatically determine the type. This property can take one of the following values: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; 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.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 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 (PKCS#12) file containing certificates. | | 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) 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 PKCS#7 file containing certificates. | | 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 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). | | 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. | | 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [ssl_cert_store_type](#ssl_cert_store_type-property), the full path of the PKCS#11 DLL as the [ssl_cert_store](#ssl_cert_store-property), and the PIN as the [ssl_cert_store_password](#ssl_cert_store_password-property). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) class by calling the [list_store_certificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [on_cert_list](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [ssl_cert_store](#ssl_cert_store-property) and set [ssl_cert_store_password](#ssl_cert_store_password-property) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 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 The subject of the certificate used for client authentication. ## Syntax ```text def get_ssl_cert_subject() -> str: ... def set_ssl_cert_subject(value: str) -> None: ... ssl_cert_subject = property(get_ssl_cert_subject, set_ssl_cert_subject) ``` ## Default Value "" ## Remarks The subject of the certificate used for client authentication. This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject. If a matching certificate is found, the property is set to the full subject of the matching certificate. If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still not found, the property is set to an empty string, and no certificate is selected. The special value "*" picks a random certificate in the certificate store. The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows: | Field | Meaning | | --- | --- | | CN | Common Name. This is commonly a hostname like www.server.com. | | O | Organization | | OU | Organizational Unit | | L | Locality | | S | State | | C | Country | | E | Email Address | If a field value contains a comma, it must be quoted. # ssl_cert_subject_alt_names property Comma-separated lists of alternative subject names for the certificate. ## Syntax ```text def get_ssl_cert_subject_alt_names() -> str: ... ssl_cert_subject_alt_names = property(get_ssl_cert_subject_alt_names, None) ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. This property is read-only. # ssl_cert_thumbprint_md5 property The MD5 hash of the certificate. ## Syntax ```text def get_ssl_cert_thumbprint_md5() -> str: ... ssl_cert_thumbprint_md5 = property(get_ssl_cert_thumbprint_md5, None) ``` ## Default Value "" ## Remarks The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. # ssl_cert_thumbprint_sha1 property The SHA-1 hash of the certificate. ## Syntax ```text def get_ssl_cert_thumbprint_sha1() -> str: ... ssl_cert_thumbprint_sha1 = property(get_ssl_cert_thumbprint_sha1, None) ``` ## Default Value "" ## Remarks The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. # ssl_cert_thumbprint_sha256 property The SHA-256 hash of the certificate. ## Syntax ```text def get_ssl_cert_thumbprint_sha256() -> str: ... ssl_cert_thumbprint_sha256 = property(get_ssl_cert_thumbprint_sha256, None) ``` ## Default Value "" ## Remarks The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. # ssl_cert_usage property The text description of UsageFlags . ## Syntax ```text def get_ssl_cert_usage() -> str: ... ssl_cert_usage = property(get_ssl_cert_usage, None) ``` ## Default Value "" ## Remarks The text description of [ssl_cert_usage_flags](#ssl_cert_usage_flags-property). This value will be one or more of the following strings and will be separated by commas: - Digital Signature - Non-Repudiation - Key Encipherment - Data Encipherment - Key Agreement - Certificate Signing - CRL Signing - Encipher Only If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names. This property is read-only. # ssl_cert_usage_flags property The flags that show intended use for the certificate. ## Syntax ```text def get_ssl_cert_usage_flags() -> int: ... ssl_cert_usage_flags = property(get_ssl_cert_usage_flags, None) ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [ssl_cert_usage_flags](#ssl_cert_usage_flags-property) is a combination of the following flags: | | | | --- | --- | | 0x80 | Digital Signature | | 0x40 | Non-Repudiation | | 0x20 | Key Encipherment | | 0x10 | Data Encipherment | | 0x08 | Key Agreement | | 0x04 | Certificate Signing | | 0x02 | CRL Signing | | 0x01 | Encipher Only | Please see the [ssl_cert_usage](#ssl_cert_usage-property) property for a text representation of [ssl_cert_usage_flags](#ssl_cert_usage_flags-property). This functionality currently is not available when the provider is OpenSSL. This property is read-only. # ssl_cert_version property The certificate's version number. ## Syntax ```text def get_ssl_cert_version() -> str: ... ssl_cert_version = property(get_ssl_cert_version, None) ``` ## Default Value "" ## Remarks The certificate's version number. The possible values are the strings "V1", "V2", and "V3". This property is read-only. # ssl_provider property The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. ## Syntax ```text def get_ssl_provider() -> int: ... def set_ssl_provider(value: int) -> None: ... ssl_provider = property(get_ssl_provider, set_ssl_provider) ``` ## Possible Values ```text 0 # Automatic1 # Platform2 # Internal ``` ## Default Value 0 ## Remarks This property specifies the SSL/TLS implementation to use. In most cases the default value of *0* (Automatic) is recommended and should not be changed. When set to *0* (Automatic), the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used. Possible values are as follows: | | | | --- | --- | | 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](#SSLEnabledProtocols), the class will always try and use the platform implementation. If the platform TLS 1.3 implementation is not available, the internal implementation will be used. # ssl_server_cert_effective_date property The date on which this certificate becomes valid. ## Syntax ```text def get_ssl_server_cert_effective_date() -> str: ... ssl_server_cert_effective_date = property(get_ssl_server_cert_effective_date, None) ``` ## Default Value "" ## Remarks The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2000 15:00:00. This property is read-only. # ssl_server_cert_encoded property The certificate (PEM/Base64 encoded). ## Syntax ```text def get_ssl_server_cert_encoded() -> bytes: ... ssl_server_cert_encoded = property(get_ssl_server_cert_encoded, None) ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [ssl_server_cert_store](#ssl_server_cert_store-property) and [ssl_server_cert_subject](#ssl_server_cert_subject-property) properties also may be used to specify a certificate. When [ssl_server_cert_encoded](#ssl_server_cert_encoded-property) is set, a search is initiated in the current [ssl_server_cert_store](#ssl_server_cert_store-property) for the private key of the certificate. If the key is found, [ssl_server_cert_subject](#ssl_server_cert_subject-property) is updated to reflect the full subject of the selected certificate; otherwise, [ssl_server_cert_subject](#ssl_server_cert_subject-property) is set to an empty string. This property is read-only. # ssl_server_cert_expiration_date property The date on which the certificate expires. ## Syntax ```text def get_ssl_server_cert_expiration_date() -> str: ... ssl_server_cert_expiration_date = property(get_ssl_server_cert_expiration_date, None) ``` ## Default Value "" ## Remarks The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2001 15:00:00. This property is read-only. # ssl_server_cert_extended_key_usage property A comma-delimited list of extended key usage identifiers. ## Syntax ```text def get_ssl_server_cert_extended_key_usage() -> str: ... ssl_server_cert_extended_key_usage = property(get_ssl_server_cert_extended_key_usage, None) ``` ## Default Value "" ## Remarks A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). This property is read-only. # ssl_server_cert_fingerprint property The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax ```text def get_ssl_server_cert_fingerprint() -> str: ... ssl_server_cert_fingerprint = property(get_ssl_server_cert_fingerprint, None) ``` ## Default Value "" ## Remarks The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02* This property is read-only. # ssl_server_cert_fingerprint_sha1 property The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax ```text def get_ssl_server_cert_fingerprint_sha1() -> str: ... ssl_server_cert_fingerprint_sha1 = property(get_ssl_server_cert_fingerprint_sha1, None) ``` ## Default Value "" ## Remarks The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84* This property is read-only. # ssl_server_cert_fingerprint_sha256 property The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax ```text def get_ssl_server_cert_fingerprint_sha256() -> str: ... ssl_server_cert_fingerprint_sha256 = property(get_ssl_server_cert_fingerprint_sha256, None) ``` ## Default Value "" ## Remarks The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53* This property is read-only. # ssl_server_cert_issuer property The issuer of the certificate. ## Syntax ```text def get_ssl_server_cert_issuer() -> str: ... ssl_server_cert_issuer = property(get_ssl_server_cert_issuer, None) ``` ## Default Value "" ## Remarks The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate. This property is read-only. # ssl_server_cert_private_key property The private key of the certificate (if available). ## Syntax ```text def get_ssl_server_cert_private_key() -> str: ... ssl_server_cert_private_key = property(get_ssl_server_cert_private_key, None) ``` ## Default Value "" ## Remarks The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [ssl_server_cert_private_key](#ssl_server_cert_private_key-property) may be available but not exportable. In this case, [ssl_server_cert_private_key](#ssl_server_cert_private_key-property) returns an empty string. This property is read-only. # ssl_server_cert_private_key_available property Whether a PrivateKey is available for the selected certificate. ## Syntax ```text def get_ssl_server_cert_private_key_available() -> bool: ... ssl_server_cert_private_key_available = property(get_ssl_server_cert_private_key_available, None) ``` ## Default Value FALSE ## Remarks Whether a [ssl_server_cert_private_key](#ssl_server_cert_private_key-property) is available for the selected certificate. If [ssl_server_cert_private_key_available](#ssl_server_cert_private_key_available-property) is True, the certificate may be used for authentication purposes (e.g., server authentication). This property is read-only. # ssl_server_cert_private_key_container property The name of the PrivateKey container for the certificate (if available). ## Syntax ```text def get_ssl_server_cert_private_key_container() -> str: ... ssl_server_cert_private_key_container = property(get_ssl_server_cert_private_key_container, None) ``` ## Default Value "" ## Remarks The name of the [ssl_server_cert_private_key](#ssl_server_cert_private_key-property) container for the certificate (if available). This functionality is available only on Windows platforms. This property is read-only. # ssl_server_cert_public_key property The public key of the certificate. ## Syntax ```text def get_ssl_server_cert_public_key() -> str: ... ssl_server_cert_public_key = property(get_ssl_server_cert_public_key, None) ``` ## Default Value "" ## Remarks The public key of the certificate. The key is provided as PEM/Base64-encoded data. This property is read-only. # ssl_server_cert_public_key_algorithm property The textual description of the certificate's public key algorithm. ## Syntax ```text def get_ssl_server_cert_public_key_algorithm() -> str: ... ssl_server_cert_public_key_algorithm = property(get_ssl_server_cert_public_key_algorithm, None) ``` ## Default Value "" ## Remarks The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm. This property is read-only. # ssl_server_cert_public_key_length property The length of the certificate's public key (in bits). ## Syntax ```text def get_ssl_server_cert_public_key_length() -> int: ... ssl_server_cert_public_key_length = property(get_ssl_server_cert_public_key_length, None) ``` ## Default Value 0 ## Remarks The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. This property is read-only. # ssl_server_cert_serial_number property The serial number of the certificate encoded as a string. ## Syntax ```text def get_ssl_server_cert_serial_number() -> str: ... ssl_server_cert_serial_number = property(get_ssl_server_cert_serial_number, None) ``` ## Default Value "" ## Remarks The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number. This property is read-only. # ssl_server_cert_signature_algorithm property The text description of the certificate's signature algorithm. ## Syntax ```text def get_ssl_server_cert_signature_algorithm() -> str: ... ssl_server_cert_signature_algorithm = property(get_ssl_server_cert_signature_algorithm, None) ``` ## Default Value "" ## Remarks The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm. This property is read-only. # ssl_server_cert_store property The name of the certificate store for the client certificate. ## Syntax ```text def get_ssl_server_cert_store() -> bytes: ... ssl_server_cert_store = property(get_ssl_server_cert_store, None) ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [ssl_server_cert_store_type](#ssl_server_cert_store_type-property) property denotes the type of the certificate store specified by [ssl_server_cert_store](#ssl_server_cert_store-property). If the store is password-protected, specify the password in [ssl_server_cert_store_password](#ssl_server_cert_store_password-property). [ssl_server_cert_store](#ssl_server_cert_store-property) is used in conjunction with the [ssl_server_cert_subject](#ssl_server_cert_subject-property) property to specify client certificates. If [ssl_server_cert_store](#ssl_server_cert_store-property) has a value, and [ssl_server_cert_subject](#ssl_server_cert_subject-property) or [ssl_server_cert_encoded](#ssl_server_cert_encoded-property) is set, a search for a certificate is initiated. Please see the [ssl_server_cert_subject](#ssl_server_cert_subject-property) property for details. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store). This property is read-only. # ssl_server_cert_store_password property If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Syntax ```text def get_ssl_server_cert_store_password() -> str: ... ssl_server_cert_store_password = property(get_ssl_server_cert_store_password, None) ``` ## Default Value "" ## Remarks If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. This property is read-only. # ssl_server_cert_store_type property The type of certificate store for this certificate. ## Syntax ```text def get_ssl_server_cert_store_type() -> int: ... ssl_server_cert_store_type = property(get_ssl_server_cert_store_type, None) ``` ## Possible Values ```text 0 # User1 # Machine2 # PFXFile3 # PFXBlob4 # JKSFile5 # JKSBlob6 # PEMKeyFile7 # PEMKeyBlob8 # PublicKeyFile9 # PublicKeyBlob10 # SSHPublicKeyBlob11 # P7BFile12 # P7BBlob13 # SSHPublicKeyFile14 # PPKFile15 # PPKBlob16 # XMLFile17 # XMLBlob18 # JWKFile19 # JWKBlob20 # SecurityKey21 # BCFKSFile22 # BCFKSBlob23 # PKCS1199 # Auto ``` ## Default Value 0 ## Remarks The type of certificate store for this certificate. The class supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the class will automatically determine the type. This property can take one of the following values: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; 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.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 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 (PKCS#12) file containing certificates. | | 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) 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 PKCS#7 file containing certificates. | | 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 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). | | 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. | | 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [ssl_server_cert_store_type](#ssl_server_cert_store_type-property), the full path of the PKCS#11 DLL as the [ssl_server_cert_store](#ssl_server_cert_store-property), and the PIN as the [ssl_server_cert_store_password](#ssl_server_cert_store_password-property). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) class by calling the [list_store_certificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [on_cert_list](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [ssl_server_cert_store](#ssl_server_cert_store-property) and set [ssl_server_cert_store_password](#ssl_server_cert_store_password-property) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 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. | This property is read-only. # ssl_server_cert_subject property The subject of the certificate used for client authentication. ## Syntax ```text def get_ssl_server_cert_subject() -> str: ... ssl_server_cert_subject = property(get_ssl_server_cert_subject, None) ``` ## Default Value "" ## Remarks The subject of the certificate used for client authentication. This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject. If a matching certificate is found, the property is set to the full subject of the matching certificate. If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still not found, the property is set to an empty string, and no certificate is selected. The special value "*" picks a random certificate in the certificate store. The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows: | Field | Meaning | | --- | --- | | CN | Common Name. This is commonly a hostname like www.server.com. | | O | Organization | | OU | Organizational Unit | | L | Locality | | S | State | | C | Country | | E | Email Address | If a field value contains a comma, it must be quoted. This property is read-only. # ssl_server_cert_subject_alt_names property Comma-separated lists of alternative subject names for the certificate. ## Syntax ```text def get_ssl_server_cert_subject_alt_names() -> str: ... ssl_server_cert_subject_alt_names = property(get_ssl_server_cert_subject_alt_names, None) ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. This property is read-only. # ssl_server_cert_thumbprint_md5 property The MD5 hash of the certificate. ## Syntax ```text def get_ssl_server_cert_thumbprint_md5() -> str: ... ssl_server_cert_thumbprint_md5 = property(get_ssl_server_cert_thumbprint_md5, None) ``` ## Default Value "" ## Remarks The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. # ssl_server_cert_thumbprint_sha1 property The SHA-1 hash of the certificate. ## Syntax ```text def get_ssl_server_cert_thumbprint_sha1() -> str: ... ssl_server_cert_thumbprint_sha1 = property(get_ssl_server_cert_thumbprint_sha1, None) ``` ## Default Value "" ## Remarks The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. # ssl_server_cert_thumbprint_sha256 property The SHA-256 hash of the certificate. ## Syntax ```text def get_ssl_server_cert_thumbprint_sha256() -> str: ... ssl_server_cert_thumbprint_sha256 = property(get_ssl_server_cert_thumbprint_sha256, None) ``` ## Default Value "" ## Remarks The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. # ssl_server_cert_usage property The text description of UsageFlags . ## Syntax ```text def get_ssl_server_cert_usage() -> str: ... ssl_server_cert_usage = property(get_ssl_server_cert_usage, None) ``` ## Default Value "" ## Remarks The text description of [ssl_server_cert_usage_flags](#ssl_server_cert_usage_flags-property). This value will be one or more of the following strings and will be separated by commas: - Digital Signature - Non-Repudiation - Key Encipherment - Data Encipherment - Key Agreement - Certificate Signing - CRL Signing - Encipher Only If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names. This property is read-only. # ssl_server_cert_usage_flags property The flags that show intended use for the certificate. ## Syntax ```text def get_ssl_server_cert_usage_flags() -> int: ... ssl_server_cert_usage_flags = property(get_ssl_server_cert_usage_flags, None) ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [ssl_server_cert_usage_flags](#ssl_server_cert_usage_flags-property) is a combination of the following flags: | | | | --- | --- | | 0x80 | Digital Signature | | 0x40 | Non-Repudiation | | 0x20 | Key Encipherment | | 0x10 | Data Encipherment | | 0x08 | Key Agreement | | 0x04 | Certificate Signing | | 0x02 | CRL Signing | | 0x01 | Encipher Only | Please see the [ssl_server_cert_usage](#ssl_server_cert_usage-property) property for a text representation of [ssl_server_cert_usage_flags](#ssl_server_cert_usage_flags-property). This functionality currently is not available when the provider is OpenSSL. This property is read-only. # ssl_server_cert_version property The certificate's version number. ## Syntax ```text def get_ssl_server_cert_version() -> str: ... ssl_server_cert_version = property(get_ssl_server_cert_version, None) ``` ## Default Value "" ## Remarks The certificate's version number. The possible values are the strings "V1", "V2", and "V3". This property is read-only. # add_attachment method Adds a file attachment to an existing event. ## Syntax ```text def add_attachment(event_id: str, name: str, local_file: str) -> None: ... ``` ## Remarks This method adds a file attachment to an existing event, specified by the *EventId* parameter. To add a more complex attachment, set the *Name* and *LocalFile* parameters to empty strings and the class will use the first attachment in the attachments properties. Note that this operation will **not** clear the attachments properties. If the file size exceeds the value set in the [AttachmentSimpleUploadLimit](#AttachmentSimpleUploadLimit) configuration, the class will use an upload session to upload the attachment in fragments. The size of these fragments is specified in the [AttachmentFragmentSize](#AttachmentFragmentSize) configuration. You can also set the *LocalFile* as an empty string, in which case the data will be read from the input stream set beforehand using set_attachment_in_stream(). **Example (Adding a Simple Attachment to a New Event)** ```text office365.CreateEvent("Event Subject", "yyyy-MM-ddTHH:mm:ss", "yyyy-MM-ddTHH:mm:ss", calendarId); string eventId = office365.Events[0].Id; office365.AddAttachment(eventId, "file1.zip", "./file1.zip"); ``` **Example (Adding a Complex Attachment to a New Event)** **Example (Uploading an Attachment in Fragments)** # authorize method Get the authorization string required to access the protected resource. ## Syntax ```text def authorize() -> None: ... ``` ## Remarks This method is used to get an access token that is required to access the protected resource. The method will act differently based on what is set in the [o_auth_client_profile](#o_auth_client_profile-property) property and the [o_auth_grant_type](#o_auth_grant_type-property) property. This method is **not** to be used in conjunction with the [authorization](#authorization-property) property. It should instead be used when setting the o_auth property. For more information, see the introduction section. # config method Sets or retrieves a configuration setting. ## Syntax ```text 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](#office365calendars-config-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](#office365calendars-config-settings), you must call *Config("PROPERTY")*. The value will be returned as a string. # create_calendar method Creates a new calendar. ## Syntax ```text def create_calendar(name: str) -> None: ... ``` ## Remarks Creates a new calendar identified by the *Name* parameter, the display name of the calendar to be created. If a calendar with the same name already exists, the class will not overwrite it and will return an error indicating conflict. The newly created calendar is added at the beginning of the calendars properties. If you need to specify more properties or customize the calendar beyond the basic creation, first create the calendar and then update it using the [update_calendar](#update_calendar-method) method. **Example (Creating a New Calendar)** ```text office365.CreateCalendar(name); string statusLine = office365.Config("StatusLine")); // It should be "HTTP/1.1 201 Created" ``` # create_event method Creates an event. The timezone is UTC. ## Syntax ```text def create_event(subject: str, start_time: str, end_time: str, calendar_id: str) -> None: ... ``` ## Remarks Creates a new event with the specified details. The *Subject* parameter defines the title or description of the event, while the *StartTime* and *EndTime* parameters specify the start and end times of the event in UTC. Both the *StartTime* and *EndTime* times should be in the format *yyyy-MM-ddTHH:mm:ss*. The *CalendarId* parameter identifies the calendar in which the event will be created. If *CalendarId* is set to "" the event will be added in the default Calendar. Attachments can also be added to the event using the [add_attachment](#add_attachment-method) method. For more details on how to add attachments, refer to the [add_attachment](#add_attachment-method) method. If you need to set additional properties or customize the event further, use the [update_event](#update_event-method) method after creation to modify attributes like location, attendees, reminders etc. **Example(Create a New event)** ```csharp office365.ListCalendars(); office365.CreateEvent("TestSub", "yyyy-MM-ddTHH:mm:ss", "yyyy-MM-ddTHH:mm:ss", office365.Calendars[index].Id); ``` # delete_attachment method Deletes an attachment. ## Syntax ```text def delete_attachment(id: str, attachment_id: str) -> None: ... ``` ## Remarks Deletes an attachment from an event using the *id* parameter to identify the event and the *attachmentId* to identify the attachment to be removed. However, this operation does not delete the attachment from the attachments properties. **Example(Delete an Attachment)** ```csharp office365.DeleteAttachment(eventId, attachmentId); ``` # delete_calendar method Deletes a calendar. ## Syntax ```text def delete_calendar(id: str) -> None: ... ``` ## Remarks Deletes a calendar identified by the *id* parameter. The calendar and all its associated events will be removed, and this operation will also delete the calendar from the calendars properties. # delete_event method Deletes an event. ## Syntax ```text def delete_event(id: str) -> None: ... ``` ## Remarks Deletes an event identified by the *id* parameter. The specified event will be permanently removed and any attachments associated with it. This method also deletes the event from the events properties. # get_calendar_view method Lists the events as calendar view. ## Syntax ```text def get_calendar_view(calendar_id: str, start_time: str, end_time: str) -> None: ... ``` ## Remarks Retrieves a list of events within a specified time range, displaying them in a calendar view format. The *calendarId* parameter identifies the calendar from which to list the events; , if left empty, the events will be listed from the default Calendar. The *StartTime* and *EndTime* parameters define the time range for the events to be retrieved and should be in the format yyyy-MM-ddTHH:mm:ss. If you do not want to specify the start and end times, you can use the [list_events](#list_events-method) method, which retrieves events without time range constraints. # get_event method Retrieves the event by Id. ## Syntax ```text def get_event(id: str) -> None: ... ``` ## Remarks This method retrieves an event specified by its ID and adds the event to the beginning of the events list. If the event already exists in the events collection, it will be removed and then added to the beginning, preventing duplication. **Example (Get an Event)** ```csharp // Retrieve an event by its ID office365.GetEvent(eventId); // Access the retrieved event OCalEvent event = office365.Events[0]; event.Subject; //event subject/title event.StartTime; event.EndTime; for(int i = 0; i < event.AttendeesCount; i++){ event.AttendeeIndex = i; event.AttendeeEmail; // the email of the attendee event.AttendeeStatusResponse; // the response of the attendee event.Body; // the body of the event } ``` # get_event_field method Retrieves the event property value by JSONPath. ## Syntax ```text def get_event_field(index: int, json_path: str) -> str: ... ``` ## Remarks This method retrieves a specific field within the event's JSON field. The first parameter, **index**, represents the index of the event in the events collection from which to retrieve the field. The second parameter, **JsonPath**, is the JSON path to the field you want to retrieve. Please refer to [XPath](#XPath) for more details on how to set the Json path. The method returns a string that represents the value of the specified JSON field. For a full list of the fields an event has/can have, please refer to the official documentation of the Office365 Calendars API documentation. **Example (Access Fields of an Event)** ```csharp office365.GetEvent(eventId); office365.GetEventField(0, "/json/hasAttachments"); // Set to true if the event has attachments. office365.GetEventField(0, "/json/end/dateTime"); // The date and time that the event ends. office365.GetEventField(0, "/json/location/displayName"); // The name associated with the location. office365.GetEventField(0, "/json/location/address/city"); // The city associated with the location. ``` # interrupt method Interrupt the current method. ## Syntax ```text def interrupt() -> None: ... ``` ## Remarks If there is no method in progress, interrupt simply returns, doing nothing. # list_attachments method Lists all of a event's attachments. ## Syntax ```text def list_attachments(id: str) -> None: ... ``` ## Remarks This method lists all of a event's attachments. This method clears and populates the attachments properties. No content data returns in this case Lists all attachments of the specified event identified by the *id* parameter, clearing and updating the attachments properties with the retrieved attachments. For each attachment found, the [on_attachment_list](#on_attachment_list-event) event is fired. Content data of the attachments is not included in the response; to access the actual content of an attachment, use the [retrieve_attachment](#retrieve_attachment-method) method. **Example(List Attachments of an Event)** ```csharp office365.ListAttachments(eventId); foreach(OCalAttachment attachment in office365.Attachments){ attachment.Id; attachment.FileName; attachment.Name; attachment.ContentType; attachment.Data; // Data is NOT accessible only by calling ListAttachments. } ``` # list_calendars method Lists the calendars. ## Syntax ```text def list_calendars() -> None: ... ``` ## Remarks Lists all calendars associated with the current user. The retrieved calendars are added to the calendars properties, which is cleared before being repopulated with the latest data. For each calendar retrieved, the [on_calendar_list](#on_calendar_list-event) event is fired. # list_events method Lists the events. ## Syntax ```text def list_events(calendar_id: str, time_min: str, time_max: str) -> None: ... ``` ## Remarks Retrieves a list of events from the specified calendar identified by the *calendarId* parameter, if this parameter is left empty, the events will be retrieved from the default calendar. The retrieved events are added to the events properties, which is cleared before being repopulated with the latest event's data. For each event retrieved, the [on_event_list](#on_event_list-event) event is fired. The *timeMin* and *timeMax* parameters are used as filters for the events to be retrieved. *timeMin* is used to filter by the lower bound of an event's end time while *timeMax* is used to filter by the upper bound of an event's start time. They must be an RFC3339 timestamp (e.g 2011-06-03T10:00:00Z). Both parameters are optional and can be replaced with an empty string for no filtering to be applied. # reset method This method will reset the class. ## Syntax ```text def reset() -> None: ... ``` ## Remarks This method will reset the class's properties to their default values. # retrieve_attachment method Retrieves an event attachment. ## Syntax ```text def retrieve_attachment(id: str, attachment_id: str) -> None: ... ``` ## Remarks Retrieves the data of a specific attachment from an event. The *id* parameter identifies the event, and the *attachmentId* specifies the attachment to be fetched. Upon retrieval, the attachment's content data is returned, making it accessible for further use. The fetched attachment can be accessed through the **Attachment*** properties, which holds the details of all retrieved attachments. **Example(Retrieve an Attachment of an Event)** ```csharp office365.RetrieveAttachment(id); office365.Attachments[0].Id; office365.Attachments[0].FileName; office365.Attachments[0].Name; office365.Attachments[0].ContentType; office365.Attachments[0].Data; } ``` # send_custom_request method Send a custom HTTP request. ## Syntax ```text def send_custom_request(http_method: str, url: str, post_data: str) -> None: ... ``` ## Remarks This method can be used to send a custom HTTP request to the server. **Example (Send a custom request): ** ```text String data = @"{ ""name"": ""My Calendar"", ""color"": ""auto"", ""isDefaultCalendar"": false, ""canShare"": true, ""canEdit"": true, ""isRemovable"": true, }"; String url = "https://graph.microsoft.com/v1.0/me/calendars"; office365.SendCustomRequest("POST", url, data); ``` # set_event_field method Sets the event field value by JSONPath. ## Syntax ```text def set_event_field(index: int, json_path: str, value: str, value_type: int) -> None: ... ``` ## Remarks This method is used to update a specific field within the event's JSON representation. Once the method is used, [update_event](#update_event-method) needs to be called for the update to take effect. The parameters for this method are as follows: the first parameter, **index**, represents the index of the event in the events collection to be edited. The second parameter, **JsonPath**, specifies the JSON path to the field you want to set. Please refer to [XPath](#XPath) for more details on how to set the Json path. The third parameter, **Value**, is the value to be assigned to the JSON field. The fourth parameter, **ValueType**, is the type of the value, which must be one of the defined types: - 0 (Object) - 1 (Array) - 2 (String) - 3 (Number) - 4 (Bool) - 5 (Null) - 6 (Raw) **Example (Set/Edit Fields of an Event before Updating): ** ```csharp // Create an event. office365.CreateEvent("Subject", "yyyy-MM-ddTHH:mm:ss", "yyyy-MM-ddTHH:mm:ss", calendarId); office365.SetEventField(0, "/json/categories", "[\"category1\", \"category2\"]", 1); office365.SetEventField(0, "/json/end", "{\"dateTime\": \"yyyy-MM-ddTHH:mm:ss\", \"timeZone\": \"UTC\"}", 0); // Update the event office365.UpdateEvent(0); ``` For a full list of the fields an event has/can have, please refer to the official documentation of the Office365 Calendars API documentation. # update_calendar method Updates a calendar. ## Syntax ```text def update_calendar(index: int) -> None: ... ``` ## Remarks This method allows you to update an existing calendar. The index parameter specifies the position of the calendar in the calendars collection. The method uses this index to take all the data from the specified calendar and update the corresponding calendar on the server. To update a calendar, edit the desired calendar fields within the calendars collection. Then, call the update_calendar method with the index of the calendar. Note that changing the JSON data will overwrite the entire calendar, ignoring other field edits made before setting the JSON. The OCalCalendar type used in the calendars collection includes the fields of a calendar. Refer to the OCalCalendar type for a complete list of fields. **Example: ** ```csharp office365.CreateCalendar(name); // Fields to update office365.Calendars[0].Name = newName; office365.Calendars[0].Color = color; // Update the calendar office365.UpdateCalendar(0); ``` # update_event method Updates an event. ## Syntax ```text def update_event(index: int) -> None: ... ``` ## Remarks This method allows you to update an existing event. The index parameter specifies the position of the event in the events collection. The method uses this index to take all the data from the specified event and update the corresponding event on the server. To update an event, edit the desired event fields within the events collection. Then, call the update_event method with the index of the event. Note that changing the JSON data will overwrite the entire event, ignoring other field edits made before setting the JSON. The OCalEvent type used in the events collection includes the fields of an event. Refer to the OCalEvent type for a complete list of fields. If you need to add other fields, you can use the [set_event_field](#set_event_field-method) method. For a complete list of fields an event can have, please refer to the Microsoft Graph API documentation. **Example:** ```csharp office365.ListCalendars(); // Create the event office365.CreateEvent("TestSub", "yyyy-MM-ddTHH:mm:ss", "yyyy-MM-ddTHH:mm:ss", office365.Calendars[index].Id); office365.Events[0].Subject = "New Test Subject"; office365.Events[0].Importance = TOCImportances.ociHigh; office365.Events[0].AttendeesCount = 2; office365.Events[0].AttendeeIndex = 0; office365.Events[0].AttendeeEmail = email1; office365.Events[0].AttendeeType = TOCAttendeeTypes.ocatRequired; office365.Events[0].AttendeeIndex = 1; office365.Events[0].AttendeeEmail = email2; office365.Events[0].AttendeeType = TOCAttendeeTypes.ocatOptional; office365.Events[0].Body = "weekly meeting"; //update the event office365.UpdateEvent(0); ``` # on_attachment_list event Fired when an attachment is retrieved from the server. ## Syntax ```text class Office365CalendarsAttachmentListEventParams(object): @property def id() -> str: ... @property def name() -> str: ... @property def content_type() -> str: ... @property def last_modified_date_time() -> str: ... @property def is_inline() -> bool: ... @property def size() -> int: ... # In class Office365Calendars: @property def on_attachment_list() -> Callable[[Office365CalendarsAttachmentListEventParams], None]: ... @on_attachment_list.setter def on_attachment_list(event_hook: Callable[[Office365CalendarsAttachmentListEventParams], None]) -> None: ... ``` ## Remarks The on_attachment_list event is fired for each attachment retrieved from the server when [list_attachments](#list_attachments-method) is called. # on_calendar_list event Fired when a calendar is retrieved from the server. ## Syntax ```text class Office365CalendarsCalendarListEventParams(object): @property def id() -> str: ... @property def name() -> str: ... # In class Office365Calendars: @property def on_calendar_list() -> Callable[[Office365CalendarsCalendarListEventParams], None]: ... @on_calendar_list.setter def on_calendar_list(event_hook: Callable[[Office365CalendarsCalendarListEventParams], None]) -> None: ... ``` ## Remarks The on_calendar_list event is fired for each calendar retrieved from the server when [list_calendars](#list_calendars-method) is called. # on_error event Fired when information is available about errors during data delivery. ## Syntax ```text class Office365CalendarsErrorEventParams(object): @property def error_code() -> int: ... @property def description() -> str: ... # In class Office365Calendars: @property def on_error() -> Callable[[Office365CalendarsErrorEventParams], None]: ... @on_error.setter def on_error(event_hook: Callable[[Office365CalendarsErrorEventParams], None]) -> None: ... ``` ## Remarks The on_error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error. The *error_code* parameter contains an error code, and the *description* parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the [Error Codes](#office365calendars-errors) section. # on_event_list event Fired when an event is retrieved from the server. ## Syntax ```text class Office365CalendarsEventListEventParams(object): @property def id() -> str: ... @property def calendar_id() -> str: ... @property def subject() -> str: ... @property def start_time() -> str: ... @property def end_time() -> str: ... # In class Office365Calendars: @property def on_event_list() -> Callable[[Office365CalendarsEventListEventParams], None]: ... @on_event_list.setter def on_event_list(event_hook: Callable[[Office365CalendarsEventListEventParams], None]) -> None: ... ``` ## Remarks The on_event_list event is fired for each event retrieved from the server when [list_events](#list_events-method) is called. This event provides details about each event, including its *Id*, the *CalendarId* it belongs to, the *Subject* (title or description), and the *StartTime* and *EndTime* times. # on_log event Fired once for each log message. ## Syntax ```text class Office365CalendarsLogEventParams(object): @property def log_level() -> int: ... @property def message() -> str: ... @property def log_type() -> str: ... # In class Office365Calendars: @property def on_log() -> Callable[[Office365CalendarsLogEventParams], None]: ... @on_log.setter def on_log(event_hook: Callable[[Office365CalendarsLogEventParams], None]) -> None: ... ``` ## Remarks This event is fired once for each log message generated by the class. The verbosity is controlled by the [LogLevel](#LogLevel) setting. *log_level* 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. *log_type* identifies the type of log entry. Possible values are as follows: - "Info" - "RequestHeaders" - "ResponseHeaders" - "RequestBody" - "ResponseBody" - "ProxyRequest" - "ProxyResponse" - "FirewallRequest" - "FirewallResponse" # on_ssl_server_authentication event Fired after the server presents its certificate to the client. ## Syntax ```text class Office365CalendarsSSLServerAuthenticationEventParams(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 Office365Calendars: @property def on_ssl_server_authentication() -> Callable[[Office365CalendarsSSLServerAuthenticationEventParams], None]: ... @on_ssl_server_authentication.setter def on_ssl_server_authentication(event_hook: Callable[[Office365CalendarsSSLServerAuthenticationEventParams], None]) -> None: ... ``` ## Remarks During this event, the client can decide whether or not to continue with the connection process. The *accept* parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue. When *accept* is False, *status* shows why the verification failed (otherwise, *status* contains the string *OK*). If it is decided to continue, you can override and accept the certificate by setting the *accept* parameter to True. # on_ssl_status event Fired when secure connection progress messages are available. ## Syntax ```text class Office365CalendarsSSLStatusEventParams(object): @property def message() -> str: ... # In class Office365Calendars: @property def on_ssl_status() -> Callable[[Office365CalendarsSSLStatusEventParams], None]: ... @on_ssl_status.setter def on_ssl_status(event_hook: Callable[[Office365CalendarsSSLStatusEventParams], None]) -> None: ... ``` ## Remarks The event is fired for informational and logging purposes only. This event tracks the progress of the connection. # on_transfer event Fired while a document transfers (delivers document). ## Syntax ```text class Office365CalendarsTransferEventParams(object): @property def direction() -> int: ... @property def bytes_transferred() -> int: ... @property def percent_done() -> int: ... @property def text() -> bytes: ... # In class Office365Calendars: @property def on_transfer() -> Callable[[Office365CalendarsTransferEventParams], None]: ... @on_transfer.setter def on_transfer(event_hook: Callable[[Office365CalendarsTransferEventParams], 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 *bytes_transferred* 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. # Office365Calendars 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](#config-method) method. ### Office365Calendars Config Settings **AttachmentFragmentSize**: Size of fragments when uploading large attachments.This setting specifies the size, in bytes, of the fragments that are uploaded during an advanced upload session when using the [add_attachment](#add_attachment-method) method. The default value is *2097152* (2MiBs). **AttachmentSimpleUploadLimit**: The threshold to use simple uploads.This setting specifies the limit before the component will switch from simple uploads to upload sessions when using the [add_attachment](#add_attachment-method) method. The default value is *2097152* (2MiBs). **CalendarsPageSize**: Page size limit for fetching calendars.This setting specifies the calendars page size, or the maximum number of calendars that will be fetched from the server in one get call. The default value is *100*. **EventsPageSize**: Page size for fetching events.This setting specifies the events page size, or the maximum number of events that will be fetched from the server in one get call. The default value is *100*. **ListCalendarsMarker**: The page marker for listing calendars.This property is populated if there are still unlisted changes after [list_calendars](#list_calendars-method) is called. It contains the nextLink that will be included as an OData parameter if [list_calendars](#list_calendars-method) is called again, this will cause the next page of calendars to be listed. **Example (List All Calendars)** ```text do { office365.ListCalendars(); } while (office365.Config("ListCalendarsMarker").Length > 0); ``` **QueryParamCount**: The number of custom HTTP Query Parameters.This setting specifies the number of custom HTTP Query parameters that will be added to a request when fetching data. The default value is *0*. **Example:** ```text component.Config("QueryParamCount=1"); component.Config("QueryParamName[0]=$orderby"); component.Config("QueryParamValue[0]=displayName"); ``` **QueryParamName[i]**: The name of a custom HTTP Query Parameter.This setting specifies the name of the custom HTTP Query parameter at index *i*. **QueryParamValue[i]**: The value of a custom HTTP Query Parameter.This setting specifies the value of the custom HTTP Query parameter at index *i*. **UserId**: Sets the Id of a shared mailbox to connect to.Specifies the Id to use when connecting to the server. When the "calendars.read.shared" scope is also added, this allows reading from shared calendars. Must be set when using Admin consented authorization flows. **XChildCount**: The number of child elements of the current element.This configuration settings specifies the number of child attributes of the current element. The XChild configuration settings will be indexed from 0 to ([XChildCount](#XChildCount) - 1). The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only. **XChildName[i]**: The name of the child element.This configuration setting provides the name of the i-th child element of the current element. The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only. **XChildXText[i]**: The inner text of the child element.This configuration setting provides the inner text of the i-th child element of the current element. The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only. **XElement**: The name of the current element.This configuration setting provides the name of the current element. The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only. **XParent**: The parent of the current element.This configuration setting provides the parent of the current element. The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only. **XPath**: Provides a way to point to a specific element in the returned XML or JSON response.The [XPath](#XPath) setting allows you to point to specific elements in the XML or JSON response. When [XPath](#XPath) is set to a valid path, [XElement](#XElement) points to the name of the element, with [XText](#XText), [XParent](#XParent), [XSubTree](#XSubTree), [XChildCount](#XChildCount), [XChildName\[i\]](#XChildName[i]), and [XChildXText\[i\]](#XChildXText[i]) providing other properties of the element. XPath syntax is available for both XML and JSON documents. An XPath is a series of one or more element accessors separated by the */* character, for example, */A/B/C/D*. An XPath can be absolute (i.e., it starts with */*), or it can be relative to the current [XPath](#XPath) location. The following are possible values for an element accessor, which operates relative to the current location specified by the XPath accessors, which proceed it in the overall XPath string: | Accessor | Description | | --- | --- | | name | The first element with a particular name. Can be *. | | [i] | The i-th element. | | name[i] | The i-th element with a particular name. | | [last()] | The last element. | | [last()-i] | The element i before the last element. | | name[@attrname="attrvalue"] | The first element with a particular name that contains the specified attribute-value pair. Supports single and double quotes. (XML Only) | | . | The current element. | | .. | The parent element. | NOTE: XPath indices are *1-based*. For example, assume the following XML and JSON responses. XML: ```text value first second value three ``` JSON: ```text { "firstlevel": { "one": "value", "two": ["first", "second"], "three": "value three" } } ``` The following are examples of valid XPaths for these responses: | Description | XML XPath | JSON XPath | | --- | --- | --- | | Document root | / | /json | | Specific element | /firstlevel/one | /json/firstlevel/one | | i-th child | /firstlevel/two/item[2] | /json/firstlevel/two/[2] | This list is not exhaustive, but it provides a general idea of the possibilities. **XSubTree**: A snapshot of the current element in the document.This configuration setting provides the entirety of the current element (including its subelements). The current element is specified through the [XPath](#XPath) configuration setting. This configuration setting is read-only. **XText**: The text of the current element.This configuration setting provides the inner text of the current element. The current element is specified in the [XPath](#XPath) configuration setting. This configuration setting is read-only. ### OAuth Config Settings **OAuthAccessTokenExpiration**: The lifetime of the access token.This setting holds the lifetime of the access token in seconds. For instance the value *3600* indicates that the token will expire in one hour from the time it was generated. **OAuthAuthorizationTokenType**: The type of access token returned.The applicable values include the following: | | | | --- | --- | | Bearer (default) | When the access token returned by the server is a Bearer type, the authorization string returned by [authorize](#authorize-method) will be in the format "Bearer access_token". This can be supplied as the value of the HTTP Authorization header. | **OAuthAutomaticRefresh**: Whether or not to refresh an expired access token automatically.When this setting is set to *True* and the [authorization](#authorization-property) property is not set, the class will automatically get a new access token if it has the necessary properties to do so without user interaction. For example, when using the Authorization Code grant type, the [o_auth_refresh_token](#o_auth_refresh_token-property) property should be set to a valid refresh token. When using the Client Credential grant type however, the class does not need any additional properties set as it can already get a new access token without user interaction. **OAuthBrowserResponseTimeout**: Specifies the amount of time to wait for a response from the browser.This setting specifies the amount of time (in seconds) the class will wait for a response from the browser when requesting user authentication. The default value is *0*, meaning that the class will wait indefinitely. **OAuthIncludeEmptyRedirectURI**: Whether an empty redirect_uri parameter is included in requests.This setting specifies whether *redirect_uri* is included in the request made by [authorize](#authorize-method) if it is empty. If set to *True* (default) the *redirect_uri* will be sent in all cases. If set to *False* the *redirect_uri* will only be sent if it has a value. **OAuthJWTPayload**: The payload of the JWT access token if present.This configuration setting provides the payload section of a JWT access token if the access token is a JWT and the class is able to parse out the payload section. This setting only applies to **access tokens** that are returned from a service provider after successfully authorizing and authenticating with the service. To parse the payload for specific claims, see [OAuthJWTXPath](#OAuthJWTXPath). **OAuthJWTXChildCount**: The number of child elements of the current element.The number of child attributes of the current element. The OAuthJWTXChildCount configuration settings will be indexed from 0 to ([OAuthJWTXChildCount](#OAuthJWTXChildCount) - 1). The current element is specified in the [OAuthJWTXPath](#OAuthJWTXPath) configuration setting. This configuration setting is read-only. **OauthJWTXChildName[i]**: The name of the child element.Provides the name of the i'th child element of the current element. The current element is specified in the [OAuthJWTXPath](#OAuthJWTXPath) configuration setting. This configuration setting is read-only. **OAuthJWTXChildXText[i]**: The inner text of the child element.Provides the inner text of the i'th child element of the current element. The current element is specified in the [OAuthJWTXPath](#OAuthJWTXPath) configuration setting. This configuration setting is read-only. **OAuthJWTXElement**: The name of the current element.Provides the name of the current element. The current element is specified in the [OAuthJWTXPath](#OAuthJWTXPath) configuration setting. This configuration setting is read-only. **OauthJWTXParent**: The parent of the current element.Provides the parent of the current element. The current element is specified in the [OAuthJWTXPath](#OAuthJWTXPath) configuration setting. This configuration setting is read-only. **OAuthJWTXPath**: Provides a way to point to a specific element in the returned payload of a JWT based access token.The [OAuthJWTXPath](#OAuthJWTXPath) setting allows you to point to specific claims within the payload of a JWT based access token. XPath syntax is available for the payload of JWT based access tokens if available. An XPath is a series of one or more element accessors separated by the */* character, for example: */A/B/C/D*. The following are possible values for an element accessor, which operates relative to the current location specified by the XPath accessors which proceed it in the overall XPath string: | Accessor | Description | | --- | --- | | name | The first element with a particular name. Can be *. | | [i] | The i-th element. | | name[i] | The i-th element with a particular name. | | [last()] | The last element. | | [last()-i] | The element i before the last element. | Here are some examples of valid XPaths and some common claims: | Description | JSON XPath | | --- | --- | | Document root | /json | | Specific element | /json/element_one | | Username Claim (Microsoft Specific) | /json/preferred_username | | Registered Application Name Claim (Microsoft Specific) | /json/app_displayname | This is not an exhaustive list by any means, but should provide a general idea of the possibilities. To get the text of the specified element, see [OAuthJWTXText](#OAuthJWTXText). **OAuthJWTXSubTree**: A snapshot of the current element in the document.Provides the entirety of the current element (including its sub-elements). The current element is specified in the [OAuthJWTXPath](#OAuthJWTXPath) configuration setting. This configuration setting is read-only. **OAuthJWTXText**: The text of the current element.Provides the inner text of the current element. The current element is specified in the [OAuthJWTXPath](#OAuthJWTXPath) configuration setting. This configuration setting is read-only. **OAuthParamCount**: Specifies the number of additional parameters variables to include in the request.This setting can be used to add query string parameters to the outgoing request. One common use for this method would be to add the "state" parameter to the request, which can be used when the [o_auth_client_profile](#o_auth_client_profile-property) is cocpWeb to add user defined data. The authorization server will include the "state" parameter in the response and will be available in the post back to your server which will allow you to maintain state in your application. This is used in conjunction with OAuthParamName[i] and OAuthParamValue[i]. For instance: ```text component.Config("OAuthParamCount=2"); component.Config("OAuthParamName[0]=myvar"); component.Config("OAuthParamValue[0]=myvalue"); component.Config("OAuthParamName[1]=testname"); component.Config("OAuthParamValue[1]=testvalue"); ``` Additionally, this will also be updated to hold the parameters returned in the response. ```text for (int i = 0; i < int.Parse(component.Config("OAuthParamCount")); i++) { string name = component.Config("OAuthParamName[" + i + "]"); string value = component.Config("OAuthParamValue[" + i + "]"); } ``` **OAuthParamName[i]**: Specifies the parameter name at the specified index.This setting can be used to retrieve or specify the parameter variable name at the index specified. See [OAuthParamCount](#OAuthParamCount) for details. **OAuthParamValue[i]**: Specifies the parameter value at the specified index.This setting can be used to retrieve or specify the parameter variable value at the index specified. See [OAuthParamCount](#OAuthParamCount) for details. **OAuthPasswordGrantUsername**: Used in the Resource Owner Password grant type.Used to set the username property when the [o_auth_grant_type](#o_auth_grant_type-property) is set to the password grant type and [authorize](#authorize-method) is called. **OAuthPKCEChallengeEncoding**: The PKCE code challenge method to use.This setting controls the PKCE code challenge method used when [OAuthUsePKCE](#OAuthUsePKCE) is set to *True*. Possible values are: - 1 (Plain) - 2 (S256/SHA256 - default) **OAuthPKCEVerifier**: The PKCE verifier used to generate the challenge.This configuration setting when queried provides the PKCE verifier that is used to generate the PKCE challenge for the [authorize](#authorize-method) method and the [o_auth_web_auth_url](#o_auth_web_auth_url-property) field when [OAuthUsePKCE](#OAuthUsePKCE) is set to true. When using the cocpWeb [o_auth_client_profile](#o_auth_client_profile-property), the configuration setting can be set instead to allow the authorization request to be made from a different instance than the authentication (token) request. **OAuthResetData**: Determines if the Reset method applies to the OAuth settings.If set to *True* (default), the [reset](#reset-method) method will reset the OAuth settings including any authorization fields like [o_auth_access_token](#o_auth_access_token-property) and [o_auth_refresh_token](#o_auth_refresh_token-property). This means the [authorize](#authorize-method) method must be called again to get new authorization information. When set to *False*, the [reset](#reset-method) method will **not** reset the o_auth property and the OAuth* configuration settings. This allows for the class to be reset without having to get authorization again. **OAuthReUseWebServer**: Determines if the same server instance is used between requests.If set to *True* (default), the same embedded web server instance will be used for multiple requests. If set to *False* the embedded web server will be created and destroyed on each call to [authorize](#authorize-method) **OAuthTransferredRequest**: The full OAuth request last sent by the client.This configuration setting returns the full OAuth request last 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 ```text Gmail gmail = new Gmail(); gmail.Config("OAuthTransferredRequest=on"); gmail.Authorize(); Console.WriteLine(gmail.Config("OAuthTransferredRequest")); ``` C++ ```text Gmail gmail; gmail.Config("OAuthTransferredRequest=on"); gmail.Authorize(); printf("%s\r\n", gmail.Config("OAuthTransferredRequest")); ``` **OAuthUsePKCE**: Specifies if PKCE should be used.If set to *True* (default), Proof Key for Code Exchange (PKCE) defined by RFC 7636 will be used when performing authorization. This setting applies when using the Authorization Code [o_auth_grant_type](#o_auth_grant_type-property). The [OAuthPKCEChallengeEncoding](#OAuthPKCEChallengeEncoding) configuration setting can be used to control the code challenge method that will be used. **OAuthWebServerActive**: Specifies and controls whether the embedded web server is active.The setting when queried will return the current state of the web server. If the webserver is active, it will return *"true"* and if it is inactive it will return *"false"*. This setting can also be set to activate or deactivate the web server. Under normal circumstances, this would not be required as the class will automatically start and stop the web server when [authorize](#authorize-method) is called. In certain cases, it is required to start the webserver before calling [authorize](#authorize-method). For example, if the [o_auth_return_url](#o_auth_return_url-property) needs to be set to a relay server, then you will need to start the web server manually. Another example would be when the [OAuthReUseWebServer](#OAuthReUseWebServer) is set to true, the server will not be automatically stopped, and this configuration setting must be set to *"false"* to stop the embedded web server. **OAuthWebServerCertStore**: The certificate with private key to use when SSL is enabled.The name of the certificate store used for the embedded web server's SSL. The [OAuthWebServerCertStoreType](#OAuthWebServerCertStoreType) property specifies the type of the certificate store specified by [OAuthWebServerCertStore](#OAuthWebServerCertStore). If the store is password protected, specify the password in [OAuthWebServerCertStorePassword](#OAuthWebServerCertStorePassword). [OAuthWebServerCertStore](#OAuthWebServerCertStore) is used in conjunction with the [OAuthWebServerCertSubject](#OAuthWebServerCertSubject) property in order to specify the certificate to be used during SSL. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store). Note: This is required when [OAuthWebServerSSLEnabled](#OAuthWebServerSSLEnabled) is set to *True*. **OAuthWebServerCertStorePassword**: The certificate with private key to use when SSL is enabled.If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store. Note: This is only applicable when [OAuthWebServerSSLEnabled](#OAuthWebServerSSLEnabled) is set to *True*. **OAuthWebServerCertStoreType**: The certificate with private key to use when SSL is enabled.This specifies the type of certificate store. Possible values are: | | | | --- | --- | | 0 | User - This is the 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 | Machine - For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. | | 2 | PFXFile - The certificate store is the name of a PFX (PKCS12) file containing certificates. | | 3 | PFXBlob - The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS12) format. | | 4 | JKSFile - The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is available only in Java. | | 5 | JKSBlob - 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 available only in Java. | | 6 | PEMKeyFile - The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. | | 7 | PEMKeyBlob - The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. | | 14 | PPKFile - The certificate store is the name of a file that contains a PPK (PuTTY Private Key). | | 15 | PPKBlob - The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). | | 16 | XMLFile - The certificate store is the name of a file that contains a certificate in XML format. | | 17 | XMLBlob - The certificate store is a string that contains a certificate in XML format. | Note: This is required when [OAuthWebServerSSLEnabled](#OAuthWebServerSSLEnabled) is set to *True*. **OAuthWebServerCertSubject**: The certificate with private key to use when SSL is enabled.The subject of the SSL certificate. 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=example@email.com". Common fields and their meanings are as follows: | Field | Meaning | | --- | --- | | CN | Common Name. This is commonly a hostname like www.server.com. | | O | Organization | | OU | Organizational Unit | | L | Locality | | S | State | | C | Country | | E | Email Address | If a field value contains a comma, it must be quoted. Note: This is required when [OAuthWebServerSSLEnabled](#OAuthWebServerSSLEnabled) is set to *True*. **OAuthWebServerFailedResponse**: The custom response that will be displayed to the user if authentication failed.When [authorize](#authorize-method) is called the user will be redirected to the embedded web server upon completing authentication with the authorization server. If authentication failed, the HTML specified here will be sent to the user's browser. **OAuthWebServerHost**: The hostname used by the embedded web server displayed in the ReturnURL.This setting specifies the hostname used by the embedded web server when [o_auth_client_profile](#o_auth_client_profile-property) is set to cocpApplication. This specifies the interface on which the embedded web server listens, and also the value displayed in the [o_auth_return_url](#o_auth_return_url-property). This should be set to the hostname only, not the full URL. The default value is *localhost*. **OAuthWebServerPort**: The local port on which the embedded web server listens.This property specifies the port on which the embedded web server listens. Setting this to *0* (default) enables the system to choose a port at random. The chosen port will be returned when this setting is queried after the server has started listening.This is only applicable when using the embedded web server. **OAuthWebServerResponse**: The custom response that will be displayed to the user.When [authorize](#authorize-method) is called the user will be redirected to the embedded web server upon completing authentication with the authorization server. This setting allows you to specify the HTML that will be sent to the user's browser. **OAuthWebServerSSLEnabled**: Whether the web server requires SSL connections.This setting specifies whether the embedded web server will use SSL. If set to *True* OAuthWebServerCert* configs are required and the server will only accept SSL connections. If set to *False* only plaintext connects are supported. ### HTTP Config Settings **AcceptEncoding**: Used to tell the server which types of content encodings the client supports.When [AllowHTTPCompression](#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](#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](#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](#authorization-property) 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](#on_transfer-event) event, by [BytesTransferred](#BytesTransferred). **ChunkSize**: Specifies the chunk size in bytes when using chunked encoding.This is applicable only when [UseChunkedEncoding](#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") or HTTP/3 ("3.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](#NegotiatedHTTPVersion) after calling a method. The [AllowHTTPFallback](#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: ```text 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. If *False*, the connection will be closed immediately after the server response is received. The default value for [KeepAlive](#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](#on_log-event) 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](#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](#proxy_user-property) and [proxy_password](#proxy_password-property) are specified, this value is calculated using the algorithm specified by [proxy_auth_scheme](#proxy_auth_scheme-property). **ProxyAuthScheme**: The authorization scheme to be used for the proxy.This configuration setting is provided for use by classes 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 classes that do not directly expose Proxy properties. **ProxyPort**: Port for the proxy server (default 80).This configuration setting is provided for use by classes 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 classes 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 classes 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. **StatusCode**: The status code of the last response from the server.This configuration setting contains the result code of the last response from the server. **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](#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 ```text Http http = new Http(); http.Config("TransferredRequest=on"); http.PostData = "body"; http.Post("http://someserver.com"); Console.WriteLine(http.Config("TransferredRequest")); ``` C++ ```text 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](#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](#CodePage) setting must be set to a value capable of interpreting the specified host name. For instance, to specify UTF-8, set [CodePage](#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. **UseProxyAutoConfigURL**: Whether to use a Proxy auto-config file when attempting a connection.This configuration specifies whether the class will attempt to use the Proxy auto-config URL when establishing a connection and [proxy_auto_detect](#proxy_auto_detect-property) is set to *True*. When *True* (default), the class will check for the existence of a Proxy auto-config URL, and if found, will determine the appropriate proxy to use. **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 classes that do not directly expose Firewall properties. **FirewallHost**: Name or IP address of firewall (optional).If a [FirewallHost](#FirewallHost) is given, requested connections will be authenticated through the specified firewall when connecting. If the [FirewallHost](#FirewallHost) setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the [FirewallHost](#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 classes that do not directly expose Firewall properties. **FirewallHTTPVersion**: The HTTP version to be used when connecting through a tunneling proxy.When [FirewallType](#FirewallType) is set to a tunneling proxy, this setting dictates which HTTP version is used when connecting. **FirewallPassword**: Password to be used if authentication is to be used when connecting through the firewall.If [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#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 classes that do not directly expose Firewall properties. **FirewallPort**: The TCP port for the FirewallHost;.The [FirewallPort](#FirewallPort) is set automatically when [FirewallType](#FirewallType) is set to a valid value. NOTE: This configuration setting is provided for use by classes that do not directly expose Firewall properties. **FirewallType**: Determines the type of firewall to connect through.Possible values are as follows: | | | | --- | --- | | 0 | No firewall (default setting). | | 1 | Connect through a tunneling proxy. [FirewallPort](#FirewallPort) is set to 80. | | 2 | Connect through a SOCKS4 Proxy. [FirewallPort](#FirewallPort) is set to 1080. | | 3 | Connect through a SOCKS5 Proxy. [FirewallPort](#FirewallPort) is set to 1080. | | 10 | Connect through a SOCKS4A Proxy. [FirewallPort](#FirewallPort) is set to 1080. | NOTE: This setting is provided for use by classes that do not directly expose Firewall properties. **FirewallUser**: A user name if authentication is to be used connecting through a firewall.If the [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#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 classes 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](#TCPKeepAlive) will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by [KeepAliveTime](#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](#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](#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](#LingerTime) is a positive value, the system will attempt to send pending data until the specified [LingerTime](#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 multihomed 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 classes) 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 multihomed hosts (machines with more than one IP interface). **LocalPort**: The port in the local host where the class binds. This configuration setting 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 configuration setting is useful when trying to connect to services that require a trusted port on 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](#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](#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](#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](#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.example.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](#KeepAliveTime) and [KeepAliveInterval](#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 set to True, the socket will send all data that are ready to send at once. When set to False, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm. By default, this configuration setting 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 as follows: | | | | --- | --- | | 0 | IPv4 only | | 1 | IPv6 only | | 2 | IPv6 with IPv4 fallback | **UseNTLMv2**: Whether to use NTLM V2.When authenticating with NTLM, this setting specifies whether NTLM V2 is used. By default this value is True and NTLM V2 will be used. Set this to False to use NTLM V1. ### SSL Config Settings **LogSSLPackets**: Controls whether SSL packets are logged when using the internal security API.When [ssl_provider](#ssl_provider-property) is set to *Internal*, this configuration setting controls whether Secure Sockets Layer (SSL) packets should be logged. By default, this configuration setting is *False*, as it is useful only for debugging purposes. When enabled, SSL packet logs are output using the [on_ssl_status](#on_ssl_status-event) event, which will fire each time an SSL packet is sent or received. Enabling this configuration setting has no effect if [ssl_provider](#ssl_provider-property) 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). OpenSSL recommends the use of 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 the following sequences: -----BEGIN CERTIFICATE----- ... (CA certificate in base64 encoding) ... -----END CERTIFICATE----- Before, between, and after the certificate text is allowed, which can be used, for example, for descriptions of the certificates. 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 configuration 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 as follows: */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 certificates to be included when performing an SSL handshake.When [ssl_provider](#ssl_provider-property) is set to *Internal*, this configuration setting specifies one or more CA certificates to be included with the ssl_cert property. Some servers or clients require the entire chain, including CA certificates, to be presented when performing SSL authentication. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance: ```text -----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE----- ``` **SSLCheckCRL**: Whether to check the Certificate Revocation List for the server certificate.This configuration setting specifies whether the class will check the Certificate Revocation List (CRL) 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 it 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 supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems. **SSLCheckOCSP**: Whether to use OCSP to check the status of the server certificate.This configuration setting specifies whether the class will use OCSP to check the validity of the server certificate. If set to 1 or 2, the class will first obtain the Online Certificate Status Protocol (OCSP) URL from the server certificate's OCSP extension. The class will then locate the issuing certificate and make an HTTP request to the OCSP 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 class will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but it will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported. This configuration setting is supported only in the Java, C#, and C++ editions. In the C++ edition, it is supported only on Windows operating systems. **SSLCipherStrength**: The minimum cipher strength used for bulk encryption. This minimum cipher strength is 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. NOTE: This configuration 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](#on_ssl_status-event) event. Use this configuration 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](#SSLCipherStrength) is currently not supported. This functionality is instead made available through the [OpenSSLCipherList](#OpenSSLCipherList) configuration setting. **SSLClientCACerts**: A newline separated list of CA certificates to use during SSL client certificate validation.This configuration setting is only applicable to server components (e.g., TCPServer) see [SSLServerCACerts](#SSLServerCACerts) for client components (e.g., TCPClient). This setting can be used to optionally specify one or more CA certificates to be used when verifying the client certificate that is presented by the client during the SSL handshake when ssl_authenticate_clients is enabled. When verifying the client's certificate, the certificates trusted by the system will be used as part of the verification process. If the client'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 configuration setting should be set only if the client's CA certificates are not already trusted on the system and cannot be installed to the trusted system store. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance: ```text -----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE----- ``` **SSLEnabledCipherSuites**: The cipher suite to be used in an SSL negotiation.This configuration setting enables the 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](#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](#ssl_provider-property) is set to *Platform* include the following: ```text obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=CALG_AES_256"); obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES"); ``` Possible values when [ssl_provider](#ssl_provider-property) is set to *Platform* include the following: - 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](#ssl_provider-property) is set to *Internal*include the following: ```text 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_ECDH_RSA_WITH_AES_128_CBC_SHA"); ``` Possible values when [ssl_provider](#ssl_provider-property) is set to *Internal* include the following: - 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_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](#SSLEnabledProtocols)), only the following cipher suites are supported: - TLS_AES_256_GCM_SHA384 - TLS_CHACHA20_POLY1305_SHA256 - TLS_AES_128_GCM_SHA256 [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) is used together with [SSLCipherStrength](#SSLCipherStrength). **SSLEnabledProtocols**: Used to enable/disable the supported security protocols.This configuration setting is used to enable or disable the supported security protocols. Not all supported protocols are enabled by default. The default value is *4032* for client components, and *3072* for server components. To specify a combination of enabled protocol versions set this config to the binary *OR* of one or more of the following values: | | | | --- | --- | | TLS1.3 | 12288 (Hex 3000) | | TLS1.2 | 3072 (Hex C00) (Default - Client and Server) | | TLS1.1 | 768 (Hex 300) (Default - Client) | | TLS1 | 192 (Hex C0) (Default - Client) | | SSL3 | 48 (Hex 30) | | SSL2 | 12 (Hex 0C) | Note that only TLS 1.2 is enabled for server components that accept incoming connections. This adheres to industry standards to ensure a secure connection. Client components enable TLS 1.0, TLS 1.1, and TLS 1.2 by default and will negotiate the highest mutually supported version when connecting to a server, which should be TLS 1.2 in most cases. **SSLEnabledProtocols: Transport Layer Security (TLS) 1.3 Notes:** By default when TLS 1.3 is enabled, the class will first try to use the platform TLS 1.3 implementation when the [ssl_provider](#ssl_provider-property) is set to Automatic for all editions. If the platform TLS 1.3 implementation is not available, the internal implementation will be used. In editions that are designed to run on Windows, [ssl_provider](#ssl_provider-property) 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 supported only 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 available only on Windows 11/Windows Server 2022 and up. - [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) and other similar SSL configuration settings are not supported. - If [SSLEnabledProtocols](#SSLEnabledProtocols) includes both TLS 1.3 and TLS 1.2, these 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. **SSLEnabledProtocols: SSL2 and SSL3 Notes: ** SSL 2.0 and 3.0 are not supported by the class when the [ssl_provider](#ssl_provider-property) is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and [ssl_provider](#ssl_provider-property) needs to be set to platform. **SSLEnableRenegotiation**: Whether the renegotiation_info SSL extension is supported.This configuration setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This configuration setting is *False* by default, but it can be set to *True* to enable the extension. This configuration setting is applicable only when [ssl_provider](#ssl_provider-property) is set to *Internal*. **SSLIncludeCertChain**: Whether the entire certificate chain is included in the SSLServerAuthentication event.This configuration setting specifies whether the Encoded parameter of the [on_ssl_server_authentication](#on_ssl_server_authentication-event) 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](#on_ssl_server_authentication-event) event. If set to True, all certificates returned by the server will be present in the Encoded parameter of the [on_ssl_server_authentication](#on_ssl_server_authentication-event) 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 configuration 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 traffic for debugging purposes. When writing to this file, the class will only append, it will not overwrite previous values. NOTE: This configuration setting is applicable only when [ssl_provider](#ssl_provider-property) is set to *Internal*. **SSLNegotiatedCipher**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedCipher[connId]"); ``` **SSLNegotiatedCipherStrength**: Returns the negotiated cipher suite strength.This configuration setting returns the strength of the cipher suite negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedCipherStrength[connId]"); ``` **SSLNegotiatedCipherSuite**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake represented as a single string. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedCipherSuite[connId]"); ``` **SSLNegotiatedKeyExchange**: Returns the negotiated key exchange algorithm.This configuration setting returns the key exchange algorithm negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedKeyExchange[connId]"); ``` **SSLNegotiatedKeyExchangeStrength**: Returns the negotiated key exchange algorithm strength.This configuration setting returns the strength of the key exchange algorithm negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedKeyExchangeStrength[connId]"); ``` **SSLNegotiatedVersion**: Returns the negotiated protocol version.This configuration setting returns the protocol version negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedVersion[connId]"); ``` **SSLSecurityFlags**: Flags that control certificate verification.The following flags are defined (specified in hexadecimal notation). They can be ORed together to exclude multiple conditions: | | | | --- | --- | | 0x00000001 | Ignore time validity status of certificate. | | 0x00000002 | Ignore time validity status of CTL. | | 0x00000004 | Ignore non-nested certificate times. | | 0x00000010 | Allow unknown certificate authority. | | 0x00000020 | Ignore wrong certificate usage. | | 0x00000100 | Ignore unknown certificate revocation status. | | 0x00000200 | Ignore unknown CTL signer revocation status. | | 0x00000400 | Ignore unknown certificate authority revocation status. | | 0x00000800 | Ignore unknown root revocation status. | | 0x00008000 | Allow test root certificate. | | 0x00004000 | Trust test root certificate. | | 0x80000000 | Ignore non-matching CN (certificate CN non-matching server name). | This functionality is currently not available when the provider is OpenSSL. **SSLServerCACerts**: A newline separated list of CA certificates to use during SSL server certificate validation.This configuration setting is only used by client components (e.g., TCPClient) see [SSLClientCACerts](#SSLClientCACerts) for server components (e.g., TCPServer). This configuration setting can be used to optionally specify one or more CA certificates to be used when connecting to the server and 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 configuration setting should be set only 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 configuration setting is a newline-separated (CR/LF) list of certificates. For instance: ```text -----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE----- ``` **TLS12SignatureAlgorithms**: Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.This configuration setting specifies the allowed server certificate signature algorithms when [ssl_provider](#ssl_provider-property) is set to *Internal* and [SSLEnabledProtocols](#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 configuration 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: ```csharp component.SSLProvider = TCPClientSSLProviders.sslpInternal; component.Config("SSLEnabledProtocols=3072"); //TLS 1.2 component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa"); ``` The default value for this configuration 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*. To not restrict the server's certificate signature algorithm, specify an empty string as the value for this configuration setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent. **TLS12SupportedGroups**: The supported groups for ECC.This configuration 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](#ssl_provider-property) 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 configuration 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 roundtrip 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 configuration setting. NOTE: All supported groups can always be used during the handshake even if not listed here, but if a group is used that is not present in this list, it will incur an additional roundtrip and time to generate the key share for that group. In most cases, this configuration setting does not need to be modified. This should be modified only 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 configuration setting holds a comma-separated list of allowed signature algorithms. Possible values include the following: - "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 configuration setting is applicable only when [SSLEnabledProtocols](#SSLEnabledProtocols) includes TLS 1.3. **TLS13SupportedGroups**: The supported groups for (EC)DHE key exchange.This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. This configuration setting should be modified only 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,mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768* 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) - "mlkem_512" (default) - "mlkem_768" (default) - "mlkem_1024" (default) - "x25519_mlkem_768" (default) - "secp256r1_mlkem_768" (default) Post-quantum algorithms (*mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768*) in our components rely on the operating system's underlying cryptographic primitives. The following platforms are currently supported: - Windows Server 2025 - Windows 11 24H2 - Windows 11 25H2 ### Socket Config Settings **AbsoluteTimeout**: Determines whether timeouts are inactivity timeouts or absolute timeouts.If [AbsoluteTimeout](#AbsoluteTimeout) is set to True, any method that 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 User Datagram Protocol (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 Transmission Control Protocol (TCP)/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. In some cases, increasing the value of the *InBufferSize* setting can provide significant improvements in performance. 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. In some cases, increasing the value of the *OutBufferSize* setting can provide significant improvements in performance. 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: | | | | --- | --- | | Identifier | Name | | 037 | IBM EBCDIC - U.S./Canada | | 437 | OEM - United States | | 500 | IBM EBCDIC - International | | 708 | Arabic - ASMO 708 | | 709 | Arabic - ASMO 449+, BCON V4 | | 710 | Arabic - Transparent Arabic | | 720 | Arabic - Transparent ASMO | | 737 | OEM - Greek (formerly 437G) | | 775 | OEM - Baltic | | 850 | OEM - Multilingual Latin I | | 852 | OEM - Latin II | | 855 | OEM - Cyrillic (primarily Russian) | | 857 | OEM - Turkish | | 858 | OEM - Multilingual Latin I + Euro symbol | | 860 | OEM - Portuguese | | 861 | OEM - Icelandic | | 862 | OEM - Hebrew | | 863 | OEM - Canadian-French | | 864 | OEM - Arabic | | 865 | OEM - Nordic | | 866 | OEM - Russian | | 869 | OEM - Modern Greek | | 870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) | | 874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) | | 875 | IBM EBCDIC - Modern Greek | | 932 | ANSI/OEM - Japanese, Shift-JIS | | 936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) | | 949 | ANSI/OEM - Korean (Unified Hangul Code) | | 950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) | | 1026 | IBM EBCDIC - Turkish (Latin-5) | | 1047 | IBM EBCDIC - Latin 1/Open System | | 1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) | | 1141 | IBM EBCDIC - Germany (20273 + Euro symbol) | | 1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) | | 1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) | | 1144 | IBM EBCDIC - Italy (20280 + Euro symbol) | | 1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) | | 1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) | | 1147 | IBM EBCDIC - France (20297 + Euro symbol) | | 1148 | IBM EBCDIC - International (500 + Euro symbol) | | 1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) | | 1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) | | 1201 | Unicode UCS-2 Big-Endian | | 1250 | ANSI - Central European | | 1251 | ANSI - Cyrillic | | 1252 | ANSI - Latin I | | 1253 | ANSI - Greek | | 1254 | ANSI - Turkish | | 1255 | ANSI - Hebrew | | 1256 | ANSI - Arabic | | 1257 | ANSI - Baltic | | 1258 | ANSI/OEM - Vietnamese | | 1361 | Korean (Johab) | | 10000 | MAC - Roman | | 10001 | MAC - Japanese | | 10002 | MAC - Traditional Chinese (Big5) | | 10003 | MAC - Korean | | 10004 | MAC - Arabic | | 10005 | MAC - Hebrew | | 10006 | MAC - Greek I | | 10007 | MAC - Cyrillic | | 10008 | MAC - Simplified Chinese (GB 2312) | | 10010 | MAC - Romania | | 10017 | MAC - Ukraine | | 10021 | MAC - Thai | | 10029 | MAC - Latin II | | 10079 | MAC - Icelandic | | 10081 | MAC - Turkish | | 10082 | MAC - Croatia | | 12000 | Unicode UCS-4 Little-Endian | | 12001 | Unicode UCS-4 Big-Endian | | 20000 | CNS - Taiwan | | 20001 | TCA - Taiwan | | 20002 | Eten - Taiwan | | 20003 | IBM5550 - Taiwan | | 20004 | TeleText - Taiwan | | 20005 | Wang - Taiwan | | 20105 | IA5 IRV International Alphabet No. 5 (7-bit) | | 20106 | IA5 German (7-bit) | | 20107 | IA5 Swedish (7-bit) | | 20108 | IA5 Norwegian (7-bit) | | 20127 | US-ASCII (7-bit) | | 20261 | T.61 | | 20269 | ISO 6937 Non-Spacing Accent | | 20273 | IBM EBCDIC - Germany | | 20277 | IBM EBCDIC - Denmark/Norway | | 20278 | IBM EBCDIC - Finland/Sweden | | 20280 | IBM EBCDIC - Italy | | 20284 | IBM EBCDIC - Latin America/Spain | | 20285 | IBM EBCDIC - United Kingdom | | 20290 | IBM EBCDIC - Japanese Katakana Extended | | 20297 | IBM EBCDIC - France | | 20420 | IBM EBCDIC - Arabic | | 20423 | IBM EBCDIC - Greek | | 20424 | IBM EBCDIC - Hebrew | | 20833 | IBM EBCDIC - Korean Extended | | 20838 | IBM EBCDIC - Thai | | 20866 | Russian - KOI8-R | | 20871 | IBM EBCDIC - Icelandic | | 20880 | IBM EBCDIC - Cyrillic (Russian) | | 20905 | IBM EBCDIC - Turkish | | 20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) | | 20932 | JIS X 0208-1990 & 0121-1990 | | 20936 | Simplified Chinese (GB2312) | | 21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) | | 21027 | Extended Alpha Lowercase | | 21866 | Ukrainian (KOI8-U) | | 28591 | ISO 8859-1 Latin I | | 28592 | ISO 8859-2 Central Europe | | 28593 | ISO 8859-3 Latin 3 | | 28594 | ISO 8859-4 Baltic | | 28595 | ISO 8859-5 Cyrillic | | 28596 | ISO 8859-6 Arabic | | 28597 | ISO 8859-7 Greek | | 28598 | ISO 8859-8 Hebrew | | 28599 | ISO 8859-9 Latin 5 | | 28605 | ISO 8859-15 Latin 9 | | 29001 | Europa 3 | | 38598 | ISO 8859-8 Hebrew | | 50220 | ISO 2022 Japanese with no halfwidth Katakana | | 50221 | ISO 2022 Japanese with halfwidth Katakana | | 50222 | ISO 2022 Japanese JIS X 0201-1989 | | 50225 | ISO 2022 Korean | | 50227 | ISO 2022 Simplified Chinese | | 50229 | ISO 2022 Traditional Chinese | | 50930 | Japanese (Katakana) Extended | | 50931 | US/Canada and Japanese | | 50933 | Korean Extended and Korean | | 50935 | Simplified Chinese Extended and Simplified Chinese | | 50936 | Simplified Chinese | | 50937 | US/Canada and Traditional Chinese | | 50939 | Japanese (Latin) Extended and Japanese | | 51932 | EUC - Japanese | | 51936 | EUC - Simplified Chinese | | 51949 | EUC - Korean | | 51950 | EUC - Traditional Chinese | | 52936 | HZ-GB2312 Simplified Chinese | | 54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) | | 57002 | ISCII Devanagari | | 57003 | ISCII Bengali | | 57004 | ISCII Tamil | | 57005 | ISCII Telugu | | 57006 | ISCII Assamese | | 57007 | ISCII Oriya | | 57008 | ISCII Kannada | | 57009 | ISCII Malayalam | | 57010 | ISCII Gujarati | | 57011 | ISCII Punjabi | | 65000 | Unicode UTF-7 | | 65001 | Unicode UTF-8 | The following is a list of valid code page identifiers for Mac OS only: | | | | --- | --- | | Identifier | Name | | 1 | ASCII | | 2 | NEXTSTEP | | 3 | JapaneseEUC | | 4 | UTF8 | | 5 | ISOLatin1 | | 6 | Symbol | | 7 | NonLossyASCII | | 8 | ShiftJIS | | 9 | ISOLatin2 | | 10 | Unicode | | 11 | WindowsCP1251 | | 12 | WindowsCP1252 | | 13 | WindowsCP1253 | | 14 | WindowsCP1254 | | 15 | WindowsCP1250 | | 21 | ISO2022JP | | 30 | MacOSRoman | | 10 | UTF16String | | 0x90000100 | UTF16BigEndian | | 0x94000100 | UTF16LittleEndian | | 0x8c000100 | UTF32String | | 0x98000100 | UTF32BigEndian | | 0x9c000100 | UTF32LittleEndian | | 65536 | Proprietary | **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. **MaskSensitiveData**: Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to *True* to mask sensitive data. The default is *True*. **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. **UseFIPSCompliantAPI**: Tells the class whether or not to use FIPS certified APIs.When set to *True*, the class will utilize the underlying operating system's certified APIs. Java editions, regardless of OS, utilize Bouncy Castle Federal Information Processing Standards (FIPS), while all other Windows editions make use of Microsoft security libraries. FIPS mode can be enabled by setting the *UseFIPSCompliantAPI* configuration setting to *True*. This is a static setting that applies to all instances of all classes of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior. For more details, please see the [FIPS 140-2 Compliance](https://www.nsoftware.com/kb/articles/fips.rst) article. NOTE: This setting is applicable only on Windows. NOTE: Enabling FIPS compliance requires a special license; please contact [sales@nsoftware.com](mailto:sales@nsoftware.com) for details. **UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *False*, the class will use the system security libraries by default to perform cryptographic functions where applicable. Setting this configuration setting to *True* tells the class to use the internal implementation instead of using the system security libraries. On Windows, this setting is set to *False* by default. On Linux/macOS, this setting is set to *True* by default. To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the [OpenSSL Notes](platforms.md) section. # Office365Calendars Errors ### Office365Calendars Errors | | | | --- | --- | | 1301 | Invalid Input Error. |