IPWorks 2020 Python Edition Reference

IPWorks 2020 Python Edition Website Download Support Questions / Feedback?
IPWorks 2020 Python Edition Introduction Licensing Instructions Atom Class Introduction Properties accept atom_data authorization auth_scheme channel_author_email channel_author_name channel_author_uri channel_category_label channel_category_scheme channel_category_term channel_contributor_email channel_contributor_name channel_contributor_uri channel_generator channel_icon channel_id channel_link_href channel_link_href_lang channel_link_length channel_link_rel channel_link_title channel_link_type channel_logo channel_rights channel_rights_text_type channel_subtitle channel_subtitle_text_type channel_title channel_title_text_type channel_updated connected content_type cookie_count cookie_domain cookie_expiration cookie_name cookie_path cookie_secure cookie_value entry_count entry_author_email entry_author_name entry_author_uri entry_category_label entry_category_scheme entry_category_term entry_content entry_content_text_type entry_contributor_email entry_contributor_name entry_contributor_uri entry_copyright entry_created entry_xml entry_id entry_issued entry_link_href entry_link_href_lang entry_link_length entry_link_rel entry_link_title entry_link_type entry_modified entry_published entry_rights entry_rights_text_type entry_source entry_summary entry_summary_text_type entry_title entry_title_text_type entry_updated firewall_auto_detect firewall_type firewall_host firewall_password firewall_port firewall_user follow_redirects idle if_modified_since local_file local_host namespace_count namespace_prefix namespace_uri other_headers parsed_header_count parsed_header_field parsed_header_value password proxy_auth_scheme proxy_auto_detect proxy_password proxy_port proxy_server proxy_ssl proxy_user referer slug ssl_accept_server_cert_encoded ssl_cert_encoded ssl_cert_store ssl_cert_store_password ssl_cert_store_type ssl_cert_subject ssl_server_cert_encoded timeout transferred_data transferred_data_limit transferred_headers update_entry_author_email update_entry_author_name update_entry_author_uri update_entry_category_label update_entry_category_scheme update_entry_category_term update_entry_content update_entry_content_text_type update_entry_contributor_email update_entry_contributor_name update_entry_contributor_uri update_entry_copyright update_entry_created update_entry_xml update_entry_id update_entry_issued update_entry_link_href update_entry_link_href_lang update_entry_link_length update_entry_link_rel update_entry_link_title update_entry_link_type update_entry_modified update_entry_published update_entry_rights update_entry_rights_text_type update_entry_source update_entry_summary update_entry_summary_text_type update_entry_title update_entry_title_text_type update_entry_updated update_file user Methods add_cookie add_namespace config delete_resource do_events get_feed get_property get_resource interrupt post_resource put put_resource read_file reset set_property write_file Events on_connected on_connection_status on_disconnected on_end_transfer on_error on_header on_log on_redirect on_set_cookie on_ssl_server_authentication on_ssl_status on_start_transfer on_status on_transfer Configuration Error Codes CalDAV Class Introduction Properties alarm_count alarm_action alarm_attachment alarm_attachment_type alarm_duration alarm_message alarm_recipient alarm_repeat alarm_subject alarm_trigger attendees authorization auth_scheme categories classification completed connected cookie_count cookie_domain cookie_expiration cookie_name cookie_path cookie_secure cookie_value created custom_property_count custom_property_attribute custom_property_name custom_property_value depth description display_name due_date duration end_date e_tag event_type firewall_auto_detect firewall_type firewall_host firewall_password firewall_port firewall_user follow_redirects free_busy_count free_busy_range free_busy_type idle last_modified local_host location lock_type lock_owner lock_scope lock_timeout lock_tokens organizer other_headers parsed_header_count parsed_header_field parsed_header_value password priority proxy_auth_scheme proxy_auto_detect proxy_password proxy_port proxy_server proxy_ssl proxy_user recurrence_dates recurrence_exception_dates recurrence_exception_rule recurrence_id recurrence_rule report_filter_alarm_end report_filter_alarm_start report_filter_custom_filter report_filter_end_date report_filter_event_type report_filter_property report_filter_recur_end report_filter_recur_start report_filter_return_calendar_data report_filter_start_date report_filter_uid sequence ssl_accept_server_cert_encoded ssl_cert_encoded ssl_cert_store ssl_cert_store_password ssl_cert_store_type ssl_cert_subject ssl_server_cert_encoded start_date status status_line summary timeout timestamp timezone_dst_name timezone_dst_offset_from timezone_dst_offset_to timezone_dst_rule timezone_dst_start timezone_last_modified timezone_std_name timezone_std_offset_from timezone_std_offset_to timezone_std_rule timezone_std_start timezone_id timezone_url transparency uid url user Methods add_cookie add_custom_property config copy_calendar_event create_calendar delete_calendar_event do_events export_ics get_calendar_event get_calendar_options get_calendar_report get_free_busy_report import_ics interrupt lock_calendar move_calendar_event put_calendar_event reset un_lock_calendar Events on_connected on_connection_status on_disconnected on_end_transfer on_error on_event_details on_free_busy on_header on_log on_redirect on_set_cookie on_ssl_server_authentication on_ssl_status on_start_transfer on_status on_transfer Configuration Error Codes CertMgr Class Introduction Properties cert_effective_date cert_encoded cert_expiration_date cert_extended_key_usage cert_fingerprint cert_issuer cert_key_password cert_private_key cert_private_key_available cert_private_key_container cert_public_key cert_public_key_algorithm cert_public_key_length cert_serial_number cert_signature_algorithm cert_subject cert_subject_alt_names cert_thumbprint_md5 cert_thumbprint_sha1 cert_thumbprint_sha256 cert_usage cert_usage_flags cert_version cert_extension_count cert_extension_critical cert_extension_oid cert_extension_value cert_store cert_store_password cert_store_type exported_cert export_format export_private_key Methods config create_certificate create_key delete_certificate delete_key export_certificate generate_csr import_certificate import_signed_csr issue_certificate list_certificate_stores list_keys list_machine_stores list_store_certificates read_certificate read_csr reset save_certificate show_certificate_chain sign_csr Events on_cert_chain on_cert_list on_error on_key_list on_log on_store_list Configuration Error Codes DNS Class Introduction Properties dns_port dns_server idle local_host protocol query_type record_count record_domain record_field_count record_field_index record_field_name record_field_value record_data record_type record_type_name record_ttl record_source recursive request_id status status_code timeout Methods config do_events get_field_value interrupt query reset Events on_error on_response on_ssl_server_authentication on_ssl_status Configuration Error Codes FileMailer Class Introduction Properties attachment_count attachment_file attachment_name auth_mechanism b_cc cc command connected delivery_notification_to firewall_auto_detect firewall_type firewall_host firewall_password firewall_port firewall_user from_ idle importance last_reply local_host mail_port mail_server message_date message_id message_recipient_count message_recipient_address message_recipient_name message_recipient_options message_recipient_type message_text other_headers password priority read_receipt_to reply_to send_to sensitivity ssl_accept_server_cert_encoded ssl_cert_encoded ssl_cert_store ssl_cert_store_password ssl_cert_store_type ssl_cert_subject ssl_enabled ssl_server_cert_encoded ssl_start_mode subject timeout user Methods add_attachment config connect disconnect do_events interrupt process_queue queue reset reset_headers send Events on_connection_status on_end_transfer on_error on_pi_trail on_ssl_server_authentication on_ssl_status on_start_transfer on_transfer Configuration Error Codes FTP Class Introduction Properties account command connected dir_list_count dir_list_entry dir_list_file_name dir_list_file_size dir_list_file_time dir_list_is_dir file_exists file_size file_time firewall_auto_detect firewall_type firewall_host firewall_password firewall_port firewall_user idle last_reply local_file local_host overwrite passive password remote_file remote_host remote_path remote_port ssl_accept_server_cert_encoded ssl_cert_encoded ssl_cert_store ssl_cert_store_password ssl_cert_store_type ssl_cert_subject ssl_enabled ssl_server_cert_encoded ssl_start_mode start_byte timeout transfer_mode user Methods abort append config delete_file do_events download interrupt list_directory list_directory_long logoff logon make_directory remove_directory rename_file reset store_unique upload Events on_connection_status on_dir_list on_end_transfer on_error on_pi_trail on_ssl_server_authentication on_ssl_status on_start_transfer on_transfer Configuration Error Codes HTMLMailer Class Introduction Properties attachment_count attachment_file attachment_name auth_mechanism b_cc cc command connected delivery_notification_to firewall_auto_detect firewall_type firewall_host firewall_password firewall_port firewall_user from_ html_file idle image_count image_data image_file image_id image_type importance last_reply local_host mail_port mail_server message_date message_html message_id message_recipient_count message_recipient_address message_recipient_name message_recipient_options message_recipient_type message_text other_headers parse_html password priority read_receipt_to reply_to send_to sensitivity ssl_accept_server_cert_encoded ssl_cert_encoded ssl_cert_store ssl_cert_store_password ssl_cert_store_type ssl_cert_subject ssl_enabled ssl_server_cert_encoded ssl_start_mode subject timeout user Methods add_attachment config connect disconnect do_events interrupt process_queue queue reset reset_headers send Events on_connection_status on_end_transfer on_error on_pi_trail on_ssl_server_authentication on_ssl_status on_start_transfer on_transfer Configuration Error Codes HTTP Class Introduction Properties accept allow_http_compression attached_file authorization auth_scheme connected content_type cookie_count cookie_domain cookie_expiration cookie_name cookie_path cookie_secure cookie_value firewall_auto_detect firewall_type firewall_host firewall_password firewall_port firewall_user follow_redirects from_ http_method http_version idle if_modified_since local_file local_host other_headers parsed_header_count parsed_header_field parsed_header_value password post_data pragma proxy_auth_scheme proxy_auto_detect proxy_password proxy_port proxy_server proxy_ssl proxy_user range referer ssl_accept_server_cert_encoded ssl_cert_encoded ssl_cert_store ssl_cert_store_password ssl_cert_store_type ssl_cert_subject ssl_server_cert_encoded status_line timeout transferred_data transferred_data_limit transferred_headers url url_path url_port url_scheme url_server user Methods add_cookie config delete do_events get head interrupt post put reset reset_headers Events on_connected on_connection_status on_disconnected on_end_transfer on_error on_header on_log on_redirect on_set_cookie on_ssl_server_authentication on_ssl_status on_start_transfer on_status on_transfer Configuration Error Codes ICMPPort Class Introduction Properties accept_data active data_to_send dont_route local_host message_sub_type message_type remote_host timeout time_to_live Methods config do_events reset send Events on_data_in on_error on_ready_to_send Configuration Error Codes IMAP Class Introduction Properties auth_mechanism auto_decode_parts command connected end_byte firewall_auto_detect firewall_type firewall_host firewall_password firewall_port firewall_user idle last_reply local_file local_host mailbox mailbox_flags mailbox_list_count mailbox_list_flags mailbox_list_name mailbox_list_separator mail_port mail_server message message_content_encoding message_content_type message_count message_date message_delivery_time message_flags message_from message_header_count message_header_field message_header_value message_headers_string message_id message_info_count message_info_date message_info_flags message_info_from message_info_message_id message_info_size message_info_subject message_in_reply_to message_net_id message_part_count message_part_content_disposition message_part_content_encoding message_part_content_id message_part_content_type message_part_filename message_part_id message_part_multipart_mode message_part_parameters message_part_size message_recipient_count message_recipient_address message_recipient_name message_recipient_options message_recipient_type message_reply_to message_sender message_set message_size message_subject message_text overwrite password peek_mode recent_message_count sort_criteria ssl_accept_server_cert_encoded ssl_cert_encoded ssl_cert_store ssl_cert_store_password ssl_cert_store_type ssl_cert_subject ssl_enabled ssl_server_cert_encoded ssl_start_mode start_byte timeout uid_mode uid_validity user Methods add_message_flags append_to_mailbox check_mailbox close_mailbox config connect copy_to_mailbox create_mailbox delete_from_mailbox delete_mailbox delete_mailbox_acl disconnect do_events examine_mailbox expunge_mailbox fetch_message_headers fetch_message_info fetch_message_part fetch_message_part_headers fetch_message_text get_mailbox_acl interrupt list_mailboxes list_subscribed_mailboxes localize_date move_to_mailbox noop rename_mailbox reset reset_message_flags search_mailbox select_mailbox set_mailbox_acl start_idle stop_idle subscribe_mailbox unset_message_flags unsubscribe_mailbox Events on_connection_status on_end_transfer on_error on_header on_idle_info on_mailbox_acl on_mailbox_list on_message_info on_message_part on_pi_trail on_ssl_server_authentication on_ssl_status on_start_transfer on_transfer Configuration Error Codes IPDaemon Class Introduction Properties connection_backlog connection_count accept_data bytes_sent connected connection_id data_to_send eol idle_timeout local_address ready_to_send record_length remote_host remote_port single_line_mode timeout user_data default_eol default_idle_timeout default_max_line_length default_single_line_mode default_timeout keep_alive linger listening local_host local_port ssl_authenticate_clients ssl_cert_encoded ssl_cert_store ssl_cert_store_password ssl_cert_store_type ssl_cert_subject ssl_enabled ssl_start_mode Methods config disconnect do_events interrupt reset send send_file send_line shutdown start_ssl Events on_connected on_connection_request on_data_in on_disconnected on_error on_ready_to_send on_ssl_client_authentication on_ssl_connection_request on_ssl_status Configuration Error Codes IPInfo Class Introduction Properties adapter_broadcast_address adapter_count adapter_description adapter_device_index adapter_dhcp_enabled adapter_dhcp_server adapter_dns_servers adapter_gateway adapter_index adapter_ip_address adapter_i_pv_6_address adapter_i_pv_6_link_local_address adapter_lease_expires adapter_lease_obtained adapter_name adapter_other_ip_addresses adapter_physical_address adapter_primary_wins_server adapter_secondary_wins_server adapter_status adapter_subnet_mask adapter_type adapter_uses_wins adapter_zone_id arp_proxy dhcp_scope dns_enabled dns_server domain_name host_address host_aliases host_name local_host node_type other_addresses other_dns_servers pending_requests request_id routing_enabled service_aliases service_name service_port service_protocol Methods config dhcp_release dhcp_renew display_dns_cache do_events flush_dns_cache get_mac reset resolve_address resolve_name Events on_dns_cache_entry on_error on_request_complete Configuration Error Codes IPMonitor Class Introduction Properties accept_data active ip_packet local_host Methods config do_events list_ip_addresses parse_pcap_file reset Events on_error on_ip_address on_ip_packet Configuration Error Codes IPPort Class Introduction Properties accept_data bytes_sent connected data_to_send eol firewall_auto_detect firewall_type firewall_host firewall_password firewall_port firewall_user keep_alive linger local_host local_port ready_to_send record_length remote_host remote_port single_line_mode ssl_accept_server_cert_encoded ssl_cert_encoded ssl_cert_store ssl_cert_store_password ssl_cert_store_type ssl_cert_subject ssl_enabled ssl_server_cert_encoded ssl_start_mode timeout Methods config connect disconnect do_events get_line interrupt reset send send_file send_line start_ssl Events on_connected on_connection_status on_data_in on_disconnected on_error on_ready_to_send on_ssl_server_authentication on_ssl_status Configuration Error Codes JSON Class Introduction Properties build_dom input_data input_file output_data output_file overwrite validate x_child_count x_child_name x_child_x_text x_element x_element_type x_error_path x_parent x_path x_sub_tree x_text Methods config end_array end_object flush has_x_path insert_property insert_value load_schema parse put_name put_property put_raw put_value remove reset save set_name set_value start_array start_object try_x_path Events on_characters on_end_document on_end_element on_error on_ignorable_whitespace on_json on_start_document on_start_element Configuration Error Codes LDAP Class Introduction Properties accept_data attr_count attr_type attr_mod_op attr_value auth_mechanism connected delete_old_rdn dn firewall_auto_detect firewall_type firewall_host firewall_password firewall_port firewall_user idle ldap_version local_host message_id page_size password reference_count reference_url result_code result_description result_dn search_deref_aliases search_return_values search_scope search_size_limit search_time_limit server_name server_port sort_attributes ssl_accept_server_cert_encoded ssl_cert_encoded ssl_cert_store ssl_cert_store_password ssl_cert_store_type ssl_cert_subject ssl_enabled ssl_server_cert_encoded ssl_start_mode timeout Methods abandon add attr bind change_password compare config delete do_events extended_request interrupt list_computers list_group_members list_groups list_user_groups modify modify_rdn move_to_dn reset search unbind Events on_computer_list on_connected on_connection_status on_disconnected on_error on_extended_response on_group_list on_pi_trail on_result on_search_complete on_search_page on_search_result on_search_result_reference on_ssl_server_authentication on_ssl_status on_user_list Configuration Error Codes MCast Class Introduction Properties accept_data active data_to_send local_host local_port loopback multicast_group receive_interface remote_host remote_port send_interface time_to_live Methods config do_events reset send Events on_data_in on_error on_ready_to_send Configuration Error Codes MIME Class Introduction Properties boundary content_type content_type_attr message message_header_count message_header_field message_header_value message_headers_string part_count part_content_disposition part_content_disposition_attr part_content_id part_content_type part_content_type_attr part_decoded_file part_decoded_string part_encoding part_filename part_headers part_name part_size Methods config decode_from_file decode_from_string encode_to_file encode_to_string reset reset_data Events on_error on_header on_progress Configuration Error Codes MX Class Introduction Properties dns_port dns_server idle local_host mail_server request_id status timeout Methods config do_events interrupt reset resolve Events on_error on_response Configuration Error Codes NetClock Class Introduction Properties idle local_host local_time protocol server_time timeout time_port time_server Methods config do_events get_and_set_time get_time interrupt reset Events on_error Configuration Error Codes NetCode Class Introduction Properties decoded_data decoded_file encoded_data encoded_file file_cnt file_name format mode overwrite progress_step Methods config decode encode reset reset_data Events on_error on_progress Configuration Error Codes NetDial Class Introduction Properties callback_number domain entry_device_name entry_device_type entry_dns_server entry_ip_address entry_phone_number entry_wins_server handle idle password phonebook phonebook_entry phone_number ras_available timeout user Methods config connect create_entry delete_entry disconnect do_events interrupt list_connections list_devices list_phonebook reset show_dial_dialog Events on_connected_entry on_device on_error on_phonebook_entry on_status Configuration Error Codes NNTP Class Introduction Properties article_count article_date article_from article_headers article_id group_overview_count group_overview_article_lines group_overview_article_number group_overview_article_size group_overview_date group_overview_from group_overview_message_id group_overview_other_headers group_overview_references group_overview_subject article_references article_reply_to article_subject article_text attached_file check_date command connected current_article current_group firewall_auto_detect firewall_type firewall_host firewall_password firewall_port firewall_user first_article group_list_count group_list_can_post group_list_first_article group_list_group group_list_last_article idle last_article last_reply local_file local_host max_lines newsgroups news_port news_server organization other_headers overview_range parsed_header_count parsed_header_field parsed_header_value password search_header search_pattern search_range ssl_accept_server_cert_encoded ssl_cert_encoded ssl_cert_store ssl_cert_store_password ssl_cert_store_type ssl_cert_subject ssl_enabled ssl_server_cert_encoded ssl_start_mode timeout user Methods config connect disconnect do_events fetch_article fetch_article_body fetch_article_headers group_overview group_search interrupt list_groups list_new_groups localize_date post_article reset reset_headers Events on_connection_status on_end_transfer on_error on_group_list on_group_overview on_group_search on_header on_pi_trail on_ssl_server_authentication on_ssl_status on_start_transfer on_transfer Configuration Error Codes OAuth Class Introduction Properties access_token authorization_code authorization_scope client_id client_profile client_secret connected cookie_count cookie_domain cookie_expiration cookie_name cookie_path cookie_secure cookie_value firewall_auto_detect firewall_type firewall_host firewall_password firewall_port firewall_user follow_redirects grant_type idle local_host other_headers param_count param_name param_value proxy_auth_scheme proxy_auto_detect proxy_password proxy_port proxy_server proxy_ssl proxy_user refresh_token return_url server_auth_url server_token_url ssl_accept_server_cert_encoded ssl_cert_encoded ssl_cert_store ssl_cert_store_password ssl_cert_store_type ssl_cert_subject ssl_server_cert_encoded timeout transferred_data transferred_headers web_server_port web_server_ssl_cert_store web_server_ssl_cert_store_password web_server_ssl_cert_store_type web_server_ssl_cert_subject web_server_ssl_enabled Methods add_cookie add_param config do_events get_authorization get_authorization_url interrupt reset start_web_server stop_web_server Events on_connected on_connection_status on_disconnected on_end_transfer on_error on_header on_launch_browser on_log on_redirect on_return_url on_set_cookie on_ssl_server_authentication on_ssl_status on_start_transfer on_status on_transfer Configuration Error Codes OData Class Introduction Properties authorization auth_scheme channel_author_email channel_author_name channel_author_uri channel_category_label channel_category_scheme channel_category_term channel_contributor_email channel_contributor_name channel_contributor_uri channel_generator channel_icon channel_id channel_link_href channel_link_href_lang channel_link_length channel_link_rel channel_link_title channel_link_type channel_logo channel_rights channel_rights_text_type channel_subtitle channel_subtitle_text_type channel_title channel_title_text_type channel_updated cookie_count cookie_domain cookie_expiration cookie_name cookie_path cookie_secure cookie_value entry_author entry_count entry_e_tag entry_id entry_index entry_links_count entry_links_resource_path entry_links_title entry_properties_count entry_properties_attributes entry_properties_is_null entry_properties_name entry_properties_type entry_properties_value entry_properties_x_path entry_summary entry_title entry_type entry_updated entry_xml firewall_auto_detect firewall_type firewall_host firewall_password firewall_port firewall_user idle local_host o_data_version other_headers other_query_options parsed_header_count parsed_header_field parsed_header_value password proxy_auth_scheme proxy_auto_detect proxy_password proxy_port proxy_server proxy_ssl proxy_user query_filter query_order_by query_select query_skip query_skip_token query_top resource_path schema_association_contains_target schema_association_description schema_association_from_role schema_association_from_role_description schema_association_from_role_entity schema_association_from_role_multiplicity schema_association_from_role_summary schema_association_name schema_association_nullable schema_association_on_delete schema_association_partner schema_association_ref_constraint_count schema_association_ref_constraint_index schema_association_ref_constraint_property schema_association_ref_constraint_referenced_property schema_association_relationship schema_association_summary schema_association_to_role schema_association_to_role_description schema_association_to_role_entity schema_association_to_role_multiplicity schema_association_to_role_summary schema_association_type schema_association_count schema_association_index schema_entity_description schema_entity_name schema_entity_summary schema_entity_count schema_entity_index schema_keys_count schema_keys schema_property_attributes schema_property_description schema_property_is_complex_type schema_property_name schema_property_nullable schema_property_summary schema_property_type schema_property_count schema_property_index schema_type_field_attributes schema_type_field_description schema_type_field_is_complex_type schema_type_field_name schema_type_field_nullable schema_type_field_summary schema_type_field_type schema_type_field_count schema_type_field_index service_root_uri ssl_accept_server_cert_encoded ssl_cert_encoded ssl_cert_store ssl_cert_store_password ssl_cert_store_type ssl_cert_subject ssl_server_cert_encoded timeout transferred_data user Methods config create_entry custom_request delete_entry get_entry_property get_schema has_x_path query_service reset set_entry_property set_schema_entity set_schema_property set_schema_type update_entry update_property Events on_connected on_disconnected on_end_transfer on_entity on_entry on_error on_header on_log on_property on_set_cookie on_ssl_server_authentication on_ssl_status on_start_transfer on_status on_transfer Configuration Error Codes Ping Class Introduction Properties active idle local_host packet_size remote_host request_id response_source response_time timeout time_to_live type_of_service Methods config do_events interrupt ping_host reset wake_on_lan Events on_error on_response Configuration Error Codes POP Class Introduction Properties auth_mechanism command connected firewall_auto_detect firewall_type firewall_host firewall_password firewall_port firewall_user idle include_headers last_reply local_file local_host mail_port mail_server max_lines message message_cc message_count message_date message_from message_header_count message_header_field message_header_value message_headers_string message_number message_recipient_count message_recipient_address message_recipient_name message_recipient_options message_recipient_type message_reply_to message_size message_subject message_text message_to message_uid password ssl_accept_server_cert_encoded ssl_cert_encoded ssl_cert_store ssl_cert_store_password ssl_cert_store_type ssl_cert_subject ssl_enabled ssl_server_cert_encoded ssl_start_mode timeout total_size user Methods config connect delete disconnect do_events interrupt list_message_sizes list_message_ui_ds localize_date reset retrieve retrieve_headers Events on_connection_status on_end_transfer on_error on_header on_message_list on_pi_trail on_ssl_server_authentication on_ssl_status on_start_transfer on_transfer Configuration Error Codes RCP Class Introduction Properties file_mode firewall_auto_detect firewall_type firewall_host firewall_password firewall_port firewall_user idle local_file local_host local_port password protocol remote_file remote_host remote_port timeout user Methods config do_events get_file interrupt put_file reset Events on_connected on_connection_status on_disconnected on_error on_progress Configuration Error Codes REST Class Introduction Properties accept authorization auth_scheme build_dom connected content_type cookie_count cookie_domain cookie_expiration cookie_name cookie_path cookie_secure cookie_value firewall_auto_detect firewall_type firewall_host firewall_password firewall_port firewall_user follow_redirects from_ http_method idle if_modified_since local_file local_host namespace_count namespace_prefix namespace_uri other_headers parsed_header_count parsed_header_field parsed_header_value password post_data proxy_auth_scheme proxy_auto_detect proxy_password proxy_port proxy_server proxy_ssl proxy_user referer ssl_accept_server_cert_encoded ssl_cert_encoded ssl_cert_store ssl_cert_store_password ssl_cert_store_type ssl_cert_subject ssl_server_cert_encoded status_line timeout transferred_data transferred_data_limit transferred_headers url user validate attr_count attr_name attr_namespace attr_prefix attr_value x_child_count x_child_name x_child_namespace x_child_prefix x_child_x_text x_element x_error_path x_namespace x_parent x_path x_prefix x_sub_tree x_text Methods add_cookie attr config delete do_events get has_x_path interrupt post put reset try_x_path Events on_characters on_comment on_connected on_connection_status on_disconnected on_end_element on_end_prefix_mapping on_end_transfer on_error on_eval_entity on_header on_ignorable_whitespace on_log on_meta on_pi on_redirect on_set_cookie on_special_section on_ssl_server_authentication on_ssl_status on_start_element on_start_prefix_mapping on_start_transfer on_status on_transfer Configuration Error Codes Rexec Class Introduction Properties bytes_sent command connected eof eol err_eol error_message firewall_auto_detect firewall_type firewall_host firewall_password firewall_port firewall_user local_host local_port remote_host remote_password remote_port remote_user stderr stdin stdout timeout Methods config disconnect do_events execute interrupt reset send Events on_connected on_connection_status on_disconnected on_error on_stderr on_stdout Configuration Error Codes Rshell Class Introduction Properties bytes_sent command connected eof eol err_eol error_message firewall_auto_detect firewall_type firewall_host firewall_password firewall_port firewall_user local_host local_port local_user remote_host remote_port remote_user stderr stdin stdout timeout Methods config disconnect do_events execute interrupt reset send Events on_connected on_connection_status on_disconnected on_error on_stderr on_stdout Configuration Error Codes RSS Class Introduction Properties accept authorization auth_scheme channel_category channel_category_domain channel_copyright channel_description channel_docs channel_generator channel_image_description channel_image_height channel_image_link channel_image_title channel_image_url channel_image_width channel_language channel_last_build_date channel_link channel_managing_editor channel_pub_date channel_skip_days channel_skip_hours channel_title channel_ttl channel_web_master connected cookie_count cookie_domain cookie_expiration cookie_name cookie_path cookie_secure cookie_value firewall_auto_detect firewall_type firewall_host firewall_password firewall_port firewall_user follow_redirects idle if_modified_since item_count item_author item_category item_category_domain item_comments item_description item_enclosure_length item_enclosure_type item_enclosure_url item_guid item_guid_is_perma_link item_xml item_link item_pub_date item_source item_source_url item_title local_file local_host namespace_count namespace_prefix namespace_uri other_headers parsed_header_count parsed_header_field parsed_header_value password proxy_auth_scheme proxy_auto_detect proxy_password proxy_port proxy_server proxy_ssl proxy_user referer rss_data rss_version ssl_accept_server_cert_encoded ssl_cert_encoded ssl_cert_store ssl_cert_store_password ssl_cert_store_type ssl_cert_subject ssl_server_cert_encoded timeout transferred_data transferred_data_limit transferred_headers user Methods add_cookie add_item add_namespace config do_events get_feed get_property get_url interrupt opml_attr put read_file read_opml reset set_property write_file Events on_connected on_connection_status on_disconnected on_end_transfer on_error on_header on_log on_opml_header on_opml_outline on_redirect on_set_cookie on_ssl_server_authentication on_ssl_status on_start_transfer on_status on_transfer Configuration Error Codes SMPP Class Introduction Properties connected firewall_auto_detect firewall_type firewall_host firewall_password firewall_port firewall_user idle local_host message_expiration message_id message_priority password protocol recipient_count recipient_address recipient_type scheduled_delivery sender_address service_type smpp_port smpp_server smpp_version ssl_accept_server_cert_encoded ssl_cert_encoded ssl_cert_store ssl_cert_store_password ssl_cert_store_type ssl_cert_subject ssl_enabled ssl_server_cert_encoded ssl_start_mode system_type timeout user_id Methods add_recipient cancel_message check_link check_message_status config connect disconnect do_events interrupt replace_message reset send_command send_data send_message Events on_connected on_connection_status on_disconnected on_error on_message_in on_message_status on_pi_trail on_ready_to_send on_ssl_server_authentication on_ssl_status Configuration Error Codes SMTP Class Introduction Properties allow_extensions auth_mechanism b_cc cc command connected delivery_notification_to firewall_auto_detect firewall_type firewall_host firewall_password firewall_port firewall_user from_ idle importance last_reply local_host mail_port mail_server message message_date message_header_count message_header_field message_header_value message_headers_string message_id message_recipient_count message_recipient_address message_recipient_name message_recipient_options message_recipient_type message_text other_headers password priority read_receipt_to reply_to return_path send_to sensitivity ssl_accept_server_cert_encoded ssl_cert_encoded ssl_cert_store ssl_cert_store_password ssl_cert_store_type ssl_cert_subject ssl_enabled ssl_server_cert_encoded ssl_start_mode subject timeout user Methods config connect disconnect do_events expand interrupt process_queue queue reset reset_headers send send_to_terminal_and_email send_to_terminal_only send_to_terminal_or_email verify Events on_connection_status on_end_transfer on_error on_expand on_pi_trail on_ssl_server_authentication on_ssl_status on_start_transfer on_transfer Configuration Error Codes SNPP Class Introduction Properties caller_id command connected firewall_auto_detect firewall_type firewall_host firewall_password firewall_port firewall_user idle last_reply local_host message pager_id server_name server_port ssl_accept_server_cert_encoded ssl_cert_encoded ssl_cert_store ssl_cert_store_password ssl_cert_store_type ssl_cert_subject ssl_enabled ssl_server_cert_encoded ssl_start_mode timeout Methods config connect disconnect do_events interrupt reset send Events on_connection_status on_error on_pi_trail on_ssl_server_authentication on_ssl_status Configuration Error Codes SOAP Class Introduction Properties accept action_uri authorization auth_scheme connected content_type cookie_count cookie_domain cookie_expiration cookie_name cookie_path cookie_secure cookie_value fault_actor fault_code fault_string firewall_auto_detect firewall_type firewall_host firewall_password firewall_port firewall_user follow_redirects idle if_modified_since local_file local_host method method_uri namespace_count namespace_prefix namespace_uri other_headers param_count param_attrs param_name param_value parsed_header_count parsed_header_field parsed_header_value password pragma proxy_auth_scheme proxy_auto_detect proxy_password proxy_port proxy_server proxy_ssl proxy_user referer return_value soap_encoding soap_header soap_packet ssl_accept_server_cert_encoded ssl_cert_encoded ssl_cert_store ssl_cert_store_password ssl_cert_store_type ssl_cert_subject ssl_server_cert_encoded status_line timeout transferred_data transferred_data_limit transferred_headers url user value_format attr_count attr_name attr_namespace attr_prefix attr_value x_child_count x_child_name x_child_namespace x_child_prefix x_child_x_text x_element x_namespace x_parent x_path x_prefix x_text Methods add_cookie add_namespace add_param attr build_packet config do_events eval_packet has_x_path interrupt reset send_packet send_request try_x_path value Events on_connected on_connection_status on_disconnected on_end_transfer on_error on_header on_log on_redirect on_set_cookie on_ssl_server_authentication on_ssl_status on_start_transfer on_status on_transfer Configuration Error Codes SysLog Class Introduction Properties active local_host local_port remote_host remote_port ssl_accept_server_cert_encoded ssl_authenticate_clients ssl_cert_encoded ssl_cert_store ssl_cert_store_password ssl_cert_store_type ssl_cert_subject ssl_enabled ssl_server_cert_encoded use_tcp Methods config do_events reset send_packet Events on_connected on_connection_status on_disconnected on_error on_packet_in on_ssl_client_authentication on_ssl_server_authentication on_ssl_status Configuration Error Codes Telnet Class Introduction Properties accept_data bytes_sent command connected data_to_send dont_option do_option do_sub_option firewall_auto_detect firewall_type firewall_host firewall_password firewall_port firewall_user keep_alive linger local_host local_port remote_host remote_port ssl_accept_server_cert_encoded ssl_cert_encoded ssl_cert_store ssl_cert_store_password ssl_cert_store_type ssl_cert_subject ssl_enabled ssl_server_cert_encoded ssl_start_mode timeout transparent urgent_data will_option wont_option Methods config connect disconnect do_events reset send Events on_command on_connected on_connection_status on_data_in on_disconnected on_do on_dont on_error on_ready_to_send on_ssl_server_authentication on_ssl_status on_sub_option on_will on_wont Configuration Error Codes TFTP Class Introduction Properties idle local_file local_host max_retransmits remote_file retransmit_timeout tftp_port tftp_server timeout Methods config do_events get_file interrupt put_file reset Events on_end_transfer on_error on_start_transfer on_transfer Configuration Error Codes TraceRoute Class Introduction Properties hop_limit hop_count hop_error_code hop_error_description hop_host_address hop_host_name hop_time hop_timeout idle local_host remote_host resolve_names timeout Methods config do_events interrupt reset trace_to Events on_error on_hop on_hop_resolved Configuration Error Codes UDPPort Class Introduction Properties accept_data active data_to_send dont_route local_host local_port remote_host remote_port time_to_live Methods config do_events reset send Events on_data_in on_error on_ready_to_send Configuration Error Codes WebDAV Class Introduction Properties accept authorization auth_scheme connected cookie_count cookie_domain cookie_expiration cookie_name cookie_path cookie_secure cookie_value depth firewall_auto_detect firewall_type firewall_host firewall_password firewall_port firewall_user follow_redirects idle local_file local_host lock_owner lock_scope lock_timeout lock_tokens lock_type namespace_count namespace_prefix namespace_uri other_headers parsed_header_count parsed_header_field parsed_header_value password property_count property_attr property_name property_namespace_uri property_operation property_status property_value proxy_auth_scheme proxy_auto_detect proxy_password proxy_port proxy_server proxy_ssl proxy_user referer resource_count resource_content_language resource_content_length resource_content_type resource_display_name resource_last_modified resource_uri ssl_accept_server_cert_encoded ssl_cert_encoded ssl_cert_store ssl_cert_store_password ssl_cert_store_type ssl_cert_subject ssl_server_cert_encoded status_line timeout transferred_data transferred_data_limit transferred_headers user Methods add_cookie add_namespace config copy_resource delete_resource do_events find_properties find_property_names get_property get_resource interrupt list_directory lock_resource make_directory move_resource patch_properties post_to_resource put_resource reset set_property un_lock_resource Events on_connected on_connection_status on_dir_list on_disconnected on_end_transfer on_error on_header on_log on_redirect on_resource_properties on_set_cookie on_ssl_server_authentication on_ssl_status on_start_transfer on_status on_transfer Configuration Error Codes WebForm Class Introduction Properties accept authorization auth_scheme connected content_type cookie_count cookie_domain cookie_expiration cookie_name cookie_path cookie_secure cookie_value encoding firewall_auto_detect firewall_type firewall_host firewall_password firewall_port firewall_user follow_redirects form_var_count form_var_content_type form_var_name form_var_value from_ idle local_file local_host other_headers parsed_header_count parsed_header_field parsed_header_value password proxy_auth_scheme proxy_auto_detect proxy_password proxy_port proxy_server proxy_ssl proxy_user referer ssl_accept_server_cert_encoded ssl_cert_encoded ssl_cert_store ssl_cert_store_password ssl_cert_store_type ssl_cert_subject ssl_server_cert_encoded status_line timeout transferred_data transferred_data_limit transferred_headers url user Methods add_cookie add_form_var config do_events interrupt reset submit submit_to Events on_connected on_connection_status on_disconnected on_end_transfer on_error on_header on_log on_redirect on_set_cookie on_ssl_server_authentication on_ssl_status on_start_transfer on_status on_transfer Configuration Error Codes WebSocket Class Introduction Properties accept_data authorization auth_scheme bytes_sent connected cookie_count cookie_domain cookie_expiration cookie_name cookie_path cookie_secure cookie_value data_format data_to_send firewall_auto_detect firewall_type firewall_host firewall_password firewall_port firewall_user follow_redirects local_host local_port origin other_headers parsed_header_count parsed_header_field parsed_header_value password proxy_auth_scheme proxy_auto_detect proxy_password proxy_port proxy_server proxy_ssl proxy_user ready_to_send ssl_accept_server_cert_encoded ssl_cert_encoded ssl_cert_store ssl_cert_store_password ssl_cert_store_type ssl_cert_subject ssl_server_cert_encoded sub_protocols timeout transferred_headers user Methods add_cookie config connect disconnect do_events interrupt ping reset reset_headers send send_file send_text Events on_connected on_connection_status on_data_in on_disconnected on_error on_header on_log on_ready_to_send on_redirect on_set_cookie on_ssl_server_authentication on_ssl_status Configuration Error Codes WebUpload Class Introduction Properties accept authorization auth_scheme connected content_type cookie_count cookie_domain cookie_expiration cookie_name cookie_path cookie_secure cookie_value file_count file_var_content_type file_var_file file_var_input_data file_var_name firewall_auto_detect firewall_type firewall_host firewall_password firewall_port firewall_user follow_redirects form_var_count form_var_content_type form_var_name form_var_value from_ idle local_file local_host other_headers parsed_header_count parsed_header_field parsed_header_value password proxy_auth_scheme proxy_auto_detect proxy_password proxy_port proxy_server proxy_ssl proxy_user referer ssl_accept_server_cert_encoded ssl_cert_encoded ssl_cert_store ssl_cert_store_password ssl_cert_store_type ssl_cert_subject ssl_server_cert_encoded status_line timeout transferred_data transferred_data_limit transferred_headers url user Methods add_cookie add_file_var add_form_var config do_events interrupt reset upload upload_to Events on_connected on_connection_status on_disconnected on_end_transfer on_error on_header on_log on_redirect on_set_cookie on_ssl_server_authentication on_ssl_status on_start_transfer on_status on_transfer on_upload_progress Configuration Error Codes Whois Class Introduction Properties default_server domain_info firewall_auto_detect firewall_type firewall_host firewall_password firewall_port firewall_user idle local_host server server_port timeout Methods config do_events interrupt query reset Events on_connected on_connection_status on_disconnected on_error Configuration Error Codes XML Class Introduction Properties build_dom input_data input_file namespace_count namespace_prefix namespace_uri output_data output_file overwrite validate attr_count attr_name attr_namespace attr_prefix attr_value x_child_count x_child_name x_child_namespace x_child_prefix x_child_x_text x_comment_count x_comment_text x_element xml_declaration_encoding xml_declaration_standalone xml_declaration_version x_namespace x_parent x_path x_prefix x_sub_tree x_text Methods config end_element flush get_attr has_x_path load_dom load_schema parse put_attr put_c_data put_comment put_element put_raw put_string remove_attr remove_children remove_element reset save save_dom start_element try_x_path Events on_characters on_comment on_end_element on_end_prefix_mapping on_error on_eval_entity on_ignorable_whitespace on_meta on_pi on_special_section on_start_element on_start_prefix_mapping on_xml Configuration Error Codes XMPP Class Introduction Properties auth_domain auth_methods buddy_count buddy_group buddy_id buddy_nick_name buddy_real_name buddy_subscription connected firewall_auto_detect firewall_type firewall_host firewall_password firewall_port firewall_user im_port im_server local_directory local_file local_host message_html message_other_data message_subject message_text message_thread message_type password presence resource server_domain ssl_accept_server_cert_encoded ssl_cert_encoded ssl_cert_store ssl_cert_store_password ssl_cert_store_type ssl_cert_subject ssl_enabled ssl_server_cert_encoded ssl_start_mode status timeout user user_domain user_info_count user_info_field user_info_value Methods add cancel change_password change_presence config connect disconnect do_events interrupt probe_presence query_register register remove reset retrieve_roster send_command send_file send_message set_user_info_field subscribe_to unregister unsubscribe_to Events on_buddy_update on_connected on_connection_status on_disconnected on_end_transfer on_error on_iq on_message_in on_pi_trail on_presence on_ready_to_send on_ssl_server_authentication on_ssl_status on_start_transfer on_subscription_request on_sync on_transfer Configuration Error Codes Software License	local_file Property The path to a local file for download/upload. If the file exists, it is overwritten. Syntax def get_local_file() -> str: ... def set_local_file(value: str) -> None: ... local_file = property(get_local_file, set_local_file) Default Value "" Remarks This property is used by the upload and download methods to specify the path to a local file to be downloaded/uploaded. See the method descriptions for more information. Example (Setting LocalFile) view source `FTPControl.LocalFile =` `"C:\localfile.txt"` `FTPControl.RemoteFile =` `"remotefile.txt"` `FTPControl.Download()` `FTPControl.LocalFile =` `"C:\localfile2.txt"` `FTPControl.RemoteFile =` `"folder/remotefile2.txt"` `FTPControl.Download()`
Copyright (c) 2022 /n software inc. - All rights reserved. IPWorks 2020 Python Edition - Version 20.0 [Build 8307]