\

Namespaces

CodeItNow
Composer

Traits

Hm_Cache_Base Shared utils for Redis and Memcached
Hm_Card_Line_Parse Trait with line parsing logic
Hm_Dispatch_Redirect
Hm_Handler_Module_Exec Handler module execution methods
Hm_Handler_Validate Methods used to validate handler module operations, like the HTTP request type and target/origin values
Hm_List Message list struct used for user notices and system debug
Hm_Module_Output Module data management. These functions provide an interface for modules (both handler and output) to fetch data set by other modules and to return their own output. Handler modules must use these methods to set a response, output modules must if the format is AJAX, otherwise they should return an HTML5 string
Hm_Modules Trait used as the basic logic for module management
Hm_Modules_Queue Trait that manages queued modules
Hm_Output_Module_Exec Output module execution methods
Hm_Server_Connect
Hm_Server_List Struct that makes it easy for a module set to manage a list of server connections
Hm_Server_Modify Server list manager
Hm_Session_Auth
Hm_Session_Fingerprint Use for browser fingerprinting
Hm_Uid_Cache Helper struct to provide data sources the don't track messages read or flagged state (like POP3 or RSS) with an alternative.

Classes

ComposerAutoloaderInitac5d219e2f002e48ec04c730cdbc9f33
Custom_Auth Override the authentication class. This method needs to be overriden to create a custom authentication backend. You must set the "auth_type" setting in your hm3.ini file to "custom" to activate this class. More information about the base class for authentication is located here:
Custom_Session Override the session class. These are the methods that must be overriden to create a new session backend. The "session_type" value in your hm3.ini must be set to "custom" to activate this class. There are several other properties and methods that can be modified to create custom sessions:
Error
Fake_IMAP_Server
Fake_Server
Handler_Test
Hm_Address_Field
Hm_API_Curl Class for sending commands to APIs
Hm_Auth Base class for authentication Creating a new authentication method requires extending this class and overriding the check_credentials method
Hm_Auth_DB Authenticate against an included DB
Hm_Auth_Dynamic Stub for dynamic authentication
Hm_Auth_IMAP Authenticate against an IMAP server
Hm_Auth_LDAP Authenticate against an LDAP server
Hm_Auth_None Base class for authentication Creating a new authentication method requires extending this class and overriding the check_credentials method
Hm_Auth_POP3 Authenticate against a POP3 server
Hm_Cache Generic cache
Hm_Cal_Data
Hm_Cal_Event
Hm_Cal_Event_Store
Hm_Cal_Output
Hm_Card_Parse Class for parsing vCard/iCal data
Hm_Carddav
Hm_Config Base class for both site and user configuration data management
Hm_Contact
Hm_Contact_Store
Hm_Crypt Encryption with the libsodium extension
Hm_Crypt_Base
Hm_DB DB interface for the framework and modules
Hm_DB_Session This session class uses a PDO compatible DB to manage session data. It does not use PHP session handlers at all and is a completely indenpendant session system.
Hm_Debug System debug notices
Hm_Discover_Services
Hm_Dispatch Page request router that ties all the framework pieces together
Hm_Feed Connect to and parse RSS/ATOM feeds
Hm_Feed_List Manage a list of feeds
Hm_Feed_Uid_Cache Used to cahce "read" feed item ids
HM_Format Base class for output formatting. Currently JSON and HTML5 formats are supported. To add support for a new format this class must be extended and the content method needs to be overridden.
Hm_Format_HTML5 Handles HTML5 formatted results for normal HTTP requests
Hm_Format_JSON Handles JSON formatted results for AJAX requests
Hm_Functions
Hm_Functions Used to override built in functions that break unit tests
Hm_Github_Output_Module Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Github_Uid_Cache Used to cache "read" github items
Hm_Gmail_Contact_XML
Hm_Handler_ Base class for data input processing modules, called "handler modules"
Hm_Handler_2fa_check Base class for data input processing modules, called "handler modules"
Hm_Handler_account_list Base class for data input processing modules, called "handler modules"
Hm_Handler_add_feeds_to_page_data Base class for data input processing modules, called "handler modules"
Hm_Handler_add_folder_manage_link Base class for data input processing modules, called "handler modules"
Hm_Handler_add_imap_servers_to_page_data Output IMAP server data for other modules to use
Hm_Handler_add_pop3_servers_to_page_data Add a list of POP3 servers for the output modules
Hm_Handler_add_smtp_servers_to_page_data Base class for data input processing modules, called "handler modules"
Hm_Handler_advanced_search_prepare Setup advanced search
Hm_Handler_api_login_step_two Process a potential login attempt
Hm_Handler_autocomplete_contact Base class for data input processing modules, called "handler modules"
Hm_Handler_check_folder_icon_setting Check the folder list icon setting
Hm_Handler_check_for_lost_settings Process a potential login attempt
Hm_Handler_check_internal_users Base class for data input processing modules, called "handler modules"
Hm_Handler_check_missing_passwords Check for missing passwords to populate a home page dialog
Hm_Handler_close_session_early Close the session before it's automatically closed at the end of page processing
Hm_Handler_compose_profile_data Base class for data input processing modules, called "handler modules"
Hm_Handler_date Setup the date
Hm_Handler_default_page_data Setup default page data
Hm_Handler_default_sort_order_setting Check the default sort order
Hm_Handler_delete_feed Base class for data input processing modules, called "handler modules"
Hm_Handler_delete_search Base class for data input processing modules, called "handler modules"
Hm_Handler_disable_servers_page Base class for data input processing modules, called "handler modules"
Hm_Handler_feed_connect Base class for data input processing modules, called "handler modules"
Hm_Handler_feed_item_content Base class for data input processing modules, called "handler modules"
Hm_Handler_feed_list_content Base class for data input processing modules, called "handler modules"
Hm_Handler_feed_list_type Base class for data input processing modules, called "handler modules"
Hm_Handler_feed_message_action Base class for data input processing modules, called "handler modules"
Hm_Handler_feed_status Base class for data input processing modules, called "handler modules"
Hm_Handler_fetch_apod_content Base class for data input processing modules, called "handler modules"
Hm_Handler_find_message_contacts Base class for data input processing modules, called "handler modules"
Hm_Handler_fix_folder_assignments Base class for data input processing modules, called "handler modules"
Hm_Handler_flag_imap_message Flag a message
Hm_Handler_folders_server_id Base class for data input processing modules, called "handler modules"
Hm_Handler_get_calendar_date Base class for data input processing modules, called "handler modules"
Hm_Handler_get_inline_message_setting Base class for data input processing modules, called "handler modules"
Hm_Handler_get_shortcut_setting Base class for data input processing modules, called "handler modules"
Hm_Handler_get_wp_notice_data Base class for data input processing modules, called "handler modules"
Hm_Handler_github_disconnect Base class for data input processing modules, called "handler modules"
Hm_Handler_github_event_detail Base class for data input processing modules, called "handler modules"
Hm_Handler_github_folders_data Base class for data input processing modules, called "handler modules"
Hm_Handler_github_list_data Base class for data input processing modules, called "handler modules"
Hm_Handler_github_list_type Base class for data input processing modules, called "handler modules"
Hm_Handler_github_message_action Base class for data input processing modules, called "handler modules"
Hm_Handler_github_process_add_repo Base class for data input processing modules, called "handler modules"
Hm_Handler_github_process_remove_repo Base class for data input processing modules, called "handler modules"
Hm_Handler_github_status Base class for data input processing modules, called "handler modules"
Hm_Handler_hello_world_page_handler This is an example of a handler module. This one is assigned to the hello_world page identifier and will run after user data is loaded (this is done in the setup.php file). It sends a string to the output modules for this page called "hello_world_data"
Hm_Handler_highlight_list_data Base class for data input processing modules, called "handler modules"
Hm_Handler_highlight_page_data Base class for data input processing modules, called "handler modules"
Hm_Handler_highlight_process_form Base class for data input processing modules, called "handler modules"
Hm_Handler_history_record_feed_message Base class for data input processing modules, called "handler modules"
Hm_Handler_history_record_github_message Base class for data input processing modules, called "handler modules"
Hm_Handler_history_record_imap_message Base class for data input processing modules, called "handler modules"
Hm_Handler_history_record_pop3_message Base class for data input processing modules, called "handler modules"
Hm_Handler_history_record_wp_message Base class for data input processing modules, called "handler modules"
Hm_Handler_http_headers Build a list of HTTP headers to output to the browser
Hm_Handler_idle_time_check Base class for data input processing modules, called "handler modules"
Hm_Handler_imap_archive_message Archive a message
Hm_Handler_imap_bust_cache Delete IMAP cache
Hm_Handler_imap_combined_inbox Get message headers for the Everthing page
Hm_Handler_imap_connect Test a connection to an IMAP server
Hm_Handler_imap_delete Delete an IMAP server
Hm_Handler_imap_delete_message Delete a message
Hm_Handler_imap_download_message Stream a message from IMAP to the browser
Hm_Handler_imap_flagged Get message headers for the Flagged page
Hm_Handler_imap_folder_check Base class for data input processing modules, called "handler modules"
Hm_Handler_imap_folder_expand Expand an IMAP folder section
Hm_Handler_imap_folder_page Fetch the message headers for a an IMAP folder page
Hm_Handler_imap_folder_status Get the status of an IMAP folder
Hm_Handler_imap_forget Forget IMAP server credentials
Hm_Handler_imap_forward_attachments Check for attachments when forwarding a message
Hm_Handler_imap_hide Hide or unhide an IMAP server
Hm_Handler_imap_mark_as_answered Flag a message as answered
Hm_Handler_imap_mark_as_read Flag a message as read
Hm_Handler_imap_message_action Perform an IMAP message action
Hm_Handler_imap_message_content Get message content from an IMAP server
Hm_Handler_imap_message_list_type Process the list_path input argument
Hm_Handler_imap_oauth2_token_check Check for IMAP server oauth2 token refresh
Hm_Handler_imap_process_move Process an IMAP move/copy action
Hm_Handler_imap_save Save a user/pass combination for an IMAP server
Hm_Handler_imap_save_sent Save a sent message
Hm_Handler_imap_search Search for a message
Hm_Handler_imap_sent Get message headers for the Sent page
Hm_Handler_imap_show_message Stream a message from IMAP to the browser and show it
Hm_Handler_imap_status Check the status of an IMAP server connection
Hm_Handler_imap_unflag_on_send Unflag a message after replying to it
Hm_Handler_imap_unread Fetch messages for the Unread page
Hm_Handler_language Setup the current language
Hm_Handler_load_carddav_contacts Base class for data input processing modules, called "handler modules"
Hm_Handler_load_carddav_settings Base class for data input processing modules, called "handler modules"
Hm_Handler_load_contacts Base class for data input processing modules, called "handler modules"
Hm_Handler_load_edit_carddav_contact Base class for data input processing modules, called "handler modules"
Hm_Handler_load_edit_contact Base class for data input processing modules, called "handler modules"
Hm_Handler_load_edit_id Base class for data input processing modules, called "handler modules"
Hm_Handler_load_edit_ldap_contact Base class for data input processing modules, called "handler modules"
Hm_Handler_load_feed_folders Base class for data input processing modules, called "handler modules"
Hm_Handler_load_feeds_for_message_list Base class for data input processing modules, called "handler modules"
Hm_Handler_load_feeds_for_search Base class for data input processing modules, called "handler modules"
Hm_Handler_load_feeds_from_config Base class for data input processing modules, called "handler modules"
Hm_Handler_load_github_repos Base class for data input processing modules, called "handler modules"
Hm_Handler_load_gmail_contacts Base class for data input processing modules, called "handler modules"
Hm_Handler_load_imap_folders Build a list of IMAP servers as the top level folders
Hm_Handler_load_imap_servers_for_message_list Load IMAP servers for message list pages
Hm_Handler_load_imap_servers_for_search Load IMAP servers for the search page
Hm_Handler_load_imap_servers_from_config Load IMAP servers for the user config object
Hm_Handler_load_keyboard_shortcuts Base class for data input processing modules, called "handler modules"
Hm_Handler_load_ldap_contacts Base class for data input processing modules, called "handler modules"
Hm_Handler_load_ldap_settings Base class for data input processing modules, called "handler modules"
Hm_Handler_load_local_contacts Base class for data input processing modules, called "handler modules"
Hm_Handler_load_message_history Base class for data input processing modules, called "handler modules"
Hm_Handler_load_pgp_data Base class for data input processing modules, called "handler modules"
Hm_Handler_load_pop3_folders Load POP3 folder data used by the folder list
Hm_Handler_load_pop3_servers_for_message_list Load POP3 server for combined message views
Hm_Handler_load_pop3_servers_for_search Load POP3 servers up for the search page
Hm_Handler_load_pop3_servers_from_config Load POP3 servers from the user config
Hm_Handler_load_smtp_is_imap_draft Base class for data input processing modules, called "handler modules"
Hm_Handler_load_smtp_reply_to_details Base class for data input processing modules, called "handler modules"
Hm_Handler_load_smtp_servers_from_config Base class for data input processing modules, called "handler modules"
Hm_Handler_load_theme Setup currently selected theme
Hm_Handler_load_user_data Load user data
Hm_Handler_login Process a potential login attempt
Hm_Handler_logout Process a logout
Hm_Handler_message_list_type Setup the message list type based on URL arguments
Hm_Handler_mod_env Base class for data input processing modules, called "handler modules"
Hm_Handler_Module Base class for data input processing modules, called "handler modules"
Hm_Handler_Modules Class to manage all the input processing modules
Hm_Handler_nasa_folder_data Base class for data input processing modules, called "handler modules"
Hm_Handler_nux_dev_news Base class for data input processing modules, called "handler modules"
Hm_Handler_nux_homepage_data Base class for data input processing modules, called "handler modules"
Hm_Handler_pgp_compose_data Base class for data input processing modules, called "handler modules"
Hm_Handler_pgp_delete_public_key Base class for data input processing modules, called "handler modules"
Hm_Handler_pgp_import_public_key Base class for data input processing modules, called "handler modules"
Hm_Handler_pgp_message_check Base class for data input processing modules, called "handler modules"
Hm_Handler_pop3_connect Test a connection to a POP3 server
Hm_Handler_pop3_delete Delete a POP3 server from the settings page
Hm_Handler_pop3_folder_page Build the data for a POP3 folder page
Hm_Handler_pop3_forget Forget the username and password for a POP3 server
Hm_Handler_pop3_message_action Perform a message action on a POP3 message
Hm_Handler_pop3_message_content Fetch a message from a POP3 server
Hm_Handler_pop3_message_list_type Setup the list type
Hm_Handler_pop3_save Save a POP3 server on the servers page
Hm_Handler_pop3_status Check the status of a POP3 connection
Hm_Handler_prefetch_imap_folders Set IMAP server ids to prefetch on login
Hm_Handler_process_add_carddav_contact Base class for data input processing modules, called "handler modules"
Hm_Handler_process_add_carddav_contact_from_msg Base class for data input processing modules, called "handler modules"
Hm_Handler_process_add_contact Base class for data input processing modules, called "handler modules"
Hm_Handler_process_add_contact_from_message Base class for data input processing modules, called "handler modules"
Hm_Handler_process_add_event Base class for data input processing modules, called "handler modules"
Hm_Handler_process_add_feed Base class for data input processing modules, called "handler modules"
Hm_Handler_process_add_imap_server Add a new IMAP server
Hm_Handler_process_add_jmap_server Add a new JMAP server
Hm_Handler_process_add_ldap_contact Base class for data input processing modules, called "handler modules"
Hm_Handler_process_add_ldap_contact_from_message Base class for data input processing modules, called "handler modules"
Hm_Handler_process_add_pop3_server Add a new POP3 server
Hm_Handler_process_add_smtp_server Base class for data input processing modules, called "handler modules"
Hm_Handler_process_add_to_ldap_server Base class for data input processing modules, called "handler modules"
Hm_Handler_process_adv_search_request Process an advanced search ajax request
Hm_Handler_process_all_email_since_setting Process "since" setting for the All E-mail page in the settings page
Hm_Handler_process_all_email_source_max_setting Process input from the max per source setting for the All E-mail page in the settings page
Hm_Handler_process_all_since_setting Process "since" setting for the Everything page in the settings page
Hm_Handler_process_all_source_max_setting Process input from the max per source setting for the Everything page in the settings page
Hm_Handler_process_api_login Process a potential login attempt
Hm_Handler_process_auto_bcc Base class for data input processing modules, called "handler modules"
Hm_Handler_process_carddav_auth_settings Base class for data input processing modules, called "handler modules"
Hm_Handler_process_change_password Base class for data input processing modules, called "handler modules"
Hm_Handler_process_clear_special_folder Base class for data input processing modules, called "handler modules"
Hm_Handler_process_compose_form_submit Base class for data input processing modules, called "handler modules"
Hm_Handler_process_compose_type Base class for data input processing modules, called "handler modules"
Hm_Handler_process_create_account Base class for data input processing modules, called "handler modules"
Hm_Handler_process_default_sort_order_setting Process input from the the default sort order setting in the general settings section.
Hm_Handler_process_delete_account Base class for data input processing modules, called "handler modules"
Hm_Handler_process_delete_carddav_contact Base class for data input processing modules, called "handler modules"
Hm_Handler_process_delete_contact Base class for data input processing modules, called "handler modules"
Hm_Handler_process_delete_draft Base class for data input processing modules, called "handler modules"
Hm_Handler_process_delete_event Base class for data input processing modules, called "handler modules"
Hm_Handler_process_delete_ldap_contact Base class for data input processing modules, called "handler modules"
Hm_Handler_process_delete_prompt_setting Process input from the disable delete prompts setting
Hm_Handler_process_dynamic_login Process a potential login attempt
Hm_Handler_process_edit_carddav_contact Base class for data input processing modules, called "handler modules"
Hm_Handler_process_edit_contact Base class for data input processing modules, called "handler modules"
Hm_Handler_process_edit_shortcut Base class for data input processing modules, called "handler modules"
Hm_Handler_process_enable_2fa Base class for data input processing modules, called "handler modules"
Hm_Handler_process_enable_shortcut_setting Base class for data input processing modules, called "handler modules"
Hm_Handler_process_feed_limit_setting Base class for data input processing modules, called "handler modules"
Hm_Handler_process_feed_since_setting Base class for data input processing modules, called "handler modules"
Hm_Handler_process_flagged_since_setting Process "since" setting for the Flagged page in the settings page
Hm_Handler_process_flagged_source_max_setting Process input from the max per source setting for the Flagged page in the settings page
Hm_Handler_process_folder_create Base class for data input processing modules, called "handler modules"
Hm_Handler_process_folder_delete Base class for data input processing modules, called "handler modules"
Hm_Handler_process_folder_rename Base class for data input processing modules, called "handler modules"
Hm_Handler_process_github_authorization Base class for data input processing modules, called "handler modules"
Hm_Handler_process_github_limit_setting Base class for data input processing modules, called "handler modules"
Hm_Handler_process_github_since_setting Base class for data input processing modules, called "handler modules"
Hm_Handler_process_hide_folder_icons Process "hide folder list icons" setting
Hm_Handler_process_idle_time Base class for data input processing modules, called "handler modules"
Hm_Handler_process_idle_time_setting Base class for data input processing modules, called "handler modules"
Hm_Handler_process_imap_per_page_setting Process input from the per page count setting
Hm_Handler_process_imap_source_update Process a request to change a combined page source
Hm_Handler_process_inline_message_setting Base class for data input processing modules, called "handler modules"
Hm_Handler_process_inline_message_style Base class for data input processing modules, called "handler modules"
Hm_Handler_process_language_setting Process language setting from the general section of the settings page
Hm_Handler_process_ldap_auth_settings Base class for data input processing modules, called "handler modules"
Hm_Handler_process_ldap_fields Base class for data input processing modules, called "handler modules"
Hm_Handler_process_list_style_setting Process input from the the list style setting in the general settings section.
Hm_Handler_process_mailto_handler_setting Process input from the the mailto handler setting in the general settings section.
Hm_Handler_process_msg_part_icons Process "message part icons" setting for the message view page in the settings page
Hm_Handler_process_nasa_connection Base class for data input processing modules, called "handler modules"
Hm_Handler_process_no_password_setting Process input from the no pasword between logins setting
Hm_Handler_process_nux_add_service Base class for data input processing modules, called "handler modules"
Hm_Handler_process_nux_service Base class for data input processing modules, called "handler modules"
Hm_Handler_process_oauth2_authorization Base class for data input processing modules, called "handler modules"
Hm_Handler_process_profile_delete Base class for data input processing modules, called "handler modules"
Hm_Handler_process_profile_update Base class for data input processing modules, called "handler modules"
Hm_Handler_process_pw_update Process a password update
Hm_Handler_process_recaptcha Base class for data input processing modules, called "handler modules"
Hm_Handler_process_recover_settings_form Process a potential login attempt
Hm_Handler_process_save_form Save user settings permanently
Hm_Handler_process_search_terms Process search terms from a URL
Hm_Handler_process_send_to_contact Base class for data input processing modules, called "handler modules"
Hm_Handler_process_sent_since_setting Process "since" setting for the Sent page in the settings page
Hm_Handler_process_sent_source_max_setting Process input from the max per source setting for the Sent E-mail page in the settings page
Hm_Handler_process_server_info Build server information data
Hm_Handler_process_show_list_icons Process "show icons in message lists" setting for the message list page in the settings page
Hm_Handler_process_simple_msg_parts Process "simple message parts" setting for the message view page in the settings page
Hm_Handler_process_special_folder Base class for data input processing modules, called "handler modules"
Hm_Handler_process_start_page_setting Process input from the the start page setting in the general settings section.
Hm_Handler_process_text_only_setting Process "text only" setting for the message view page in the settings page
Hm_Handler_process_theme_setting Process theme setting from the general section of the settings page
Hm_Handler_process_timezone_setting Process the timezone setting from the general section of the settings page
Hm_Handler_process_unread_feeds_setting Base class for data input processing modules, called "handler modules"
Hm_Handler_process_unread_github_included Base class for data input processing modules, called "handler modules"
Hm_Handler_process_unread_since_setting Process "since" setting for the Unread page in the settings page
Hm_Handler_process_unread_source_max_setting Process input from the max per source setting for the Unread page in the settings page
Hm_Handler_process_unread_wp_included Base class for data input processing modules, called "handler modules"
Hm_Handler_process_update_ldap_contact Base class for data input processing modules, called "handler modules"
Hm_Handler_process_update_ldap_server Base class for data input processing modules, called "handler modules"
Hm_Handler_process_wordpress_authorization Base class for data input processing modules, called "handler modules"
Hm_Handler_process_wordpress_since_setting Base class for data input processing modules, called "handler modules"
Hm_Handler_profile_data Base class for data input processing modules, called "handler modules"
Hm_Handler_profile_edit_data Base class for data input processing modules, called "handler modules"
Hm_Handler_reload_folder_cookie Set a cookie to instruct the JS to reload the folder list
Hm_Handler_reset_search Base class for data input processing modules, called "handler modules"
Hm_Handler_save_feeds Base class for data input processing modules, called "handler modules"
Hm_Handler_save_imap_cache Save IMAP caches in the session
Hm_Handler_save_imap_servers Save IMAP servers
Hm_Handler_save_pop3_cache Save a POP3 server cache
Hm_Handler_save_pop3_servers Save POP3 server list
Hm_Handler_save_search Base class for data input processing modules, called "handler modules"
Hm_Handler_save_searches_data Base class for data input processing modules, called "handler modules"
Hm_Handler_save_smtp_servers Base class for data input processing modules, called "handler modules"
Hm_Handler_save_user_data Save user data to the session
Hm_Handler_save_user_settings Save settings from the settings page to the session
Hm_Handler_saved_search_folder_data Base class for data input processing modules, called "handler modules"
Hm_Handler_setup_github_connect Base class for data input processing modules, called "handler modules"
Hm_Handler_setup_nux Base class for data input processing modules, called "handler modules"
Hm_Handler_setup_wordpress_connect Base class for data input processing modules, called "handler modules"
Hm_Handler_site_http_headers Base class for data input processing modules, called "handler modules"
Hm_Handler_smtp_attach_file Base class for data input processing modules, called "handler modules"
Hm_Handler_smtp_auto_bcc_check Determine if auto-bcc is active
Hm_Handler_smtp_connect Base class for data input processing modules, called "handler modules"
Hm_Handler_smtp_default_server Base class for data input processing modules, called "handler modules"
Hm_Handler_smtp_delete Base class for data input processing modules, called "handler modules"
Hm_Handler_smtp_delete_attached_file Base class for data input processing modules, called "handler modules"
Hm_Handler_smtp_forget Base class for data input processing modules, called "handler modules"
Hm_Handler_smtp_from_replace Determine if composer_from is set
Hm_Handler_smtp_save Base class for data input processing modules, called "handler modules"
Hm_Handler_smtp_save_draft Base class for data input processing modules, called "handler modules"
Hm_Handler_special_folders Base class for data input processing modules, called "handler modules"
Hm_Handler_stay_logged_in Check for the "stay logged in" option
Hm_Handler_tag_data Base class for data input processing modules, called "handler modules"
Hm_Handler_Test Base class for data input processing modules, called "handler modules"
Hm_Handler_test_mod Base class for data input processing modules, called "handler modules"
Hm_Handler_title Setup a default title
Hm_Handler_update_save_search_label Base class for data input processing modules, called "handler modules"
Hm_Handler_update_search Base class for data input processing modules, called "handler modules"
Hm_Handler_vcalendar_check Base class for data input processing modules, called "handler modules"
Hm_Handler_wordpress_disconnect Base class for data input processing modules, called "handler modules"
Hm_Handler_wordpress_folders_data Base class for data input processing modules, called "handler modules"
Hm_Handler_wordpress_list_type Base class for data input processing modules, called "handler modules"
Hm_Handler_wordpress_msg_action Base class for data input processing modules, called "handler modules"
Hm_Handler_wp_load_sources Base class for data input processing modules, called "handler modules"
Hm_Handler_wp_notification_data Base class for data input processing modules, called "handler modules"
Hm_ICal Class for parsing iCal data
Hm_Image_Sources Data URLs for icons used by the interface.
Hm_IMAP
Hm_IMAP public interface to IMAP commands
Hm_IMAP_Base Base class for a generic PHP5 IMAP client library.
Hm_IMAP_Cache Cache related methods
Hm_IMAP_List
Hm_IMAP_List IMAP connection manager
Hm_IMAP_Parser IMAP specific parsing routines
Hm_IMAP_Struct Represent a message structure by parsing the results from the IMAP BODYSTRUCTURE command
Hm_JMAP public interface to JMAP commands
Hm_LDAP_Contacts Authenticate against an LDAP server
Hm_Memcached Memcached cache
Hm_Memcached_Session This session class uses a memcached to manage session data. It does not use PHP session handlers at all and is a completely indenpendant session system.
Hm_MIME_Msg Build a MIME message
Hm_Mock_Config
Hm_Mock_Memcached
Hm_Mock_Memcached_No
Hm_Mock_Redis
Hm_Mock_Redis_No
Hm_Mock_Request
Hm_Mock_Session
Hm_Module_Exec Class to setup, load, and execute module sets
Hm_Msgs Notices the user sees
Hm_Noop_Cache
Hm_Oauth2 Class for dealing with Oauth2
Hm_Output Base class that controls how data is output
Hm_Output_ Placeholder classes for disabling a module in a set. These allow a module set to replace another module set's assignments with "false" to disable them
Hm_Output_2fa_dialog Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_add_cal_event_form Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_add_feed_dialog Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_add_imap_server_dialog Format the add IMAP server dialog for the servers page
Hm_Output_add_jmap_server_dialog Format the add IMAP server dialog for the servers page
Hm_Output_add_message_contacts Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_add_pop3_server_dialog Format the add POP3 server dialog
Hm_Output_add_smtp_server_dialog Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_advanced_search_content_end End of the advanced search results content section
Hm_Output_advanced_search_content_start Start the advanced search results content section
Hm_Output_advanced_search_form_content Advanced search form content
Hm_Output_advanced_search_form_end Finish the advanced search form
Hm_Output_advanced_search_form_start Start the advanced search form
Hm_Output_advanced_search_link Advanced search link
Hm_Output_advanced_search_results_table_end Closes the advanced search results table
Hm_Output_all_email_since_setting Option for the "received since" date range for the All E-mail page
Hm_Output_all_email_source_max_setting Option for the maximum number of messages per source for the All E-mail page
Hm_Output_all_since_setting Option for the "received since" date range for the Everything page
Hm_Output_all_source_max_setting Option for the maximum number of messages per source for the Everything page
Hm_Output_apod_content Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_auto_bcc_setting Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_calendar_content Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_calendar_page_link Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_carddav_auth_settings Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_carddav_contacts_form Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_change_password Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_change_password_link Adds a link to the change password page to the folder list
Hm_Output_compose_form_attach Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_compose_form_content Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_compose_form_draft_list Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_compose_form_end Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_compose_form_start Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_compose_page_link Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_compose_signature_button Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_compose_signature_values Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_compose_type_setting Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_config_map Output the current configuration setup
Hm_Output_contacts_content_end Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_contacts_content_start Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_contacts_form Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_contacts_list Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_contacts_page_link Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_content_end End the page content
Hm_Output_content_section_end Closes the main content section
Hm_Output_content_section_start Starts the main content section
Hm_Output_content_start Start the content section
Hm_Output_create_account_link Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_create_form Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_date Output a date
Hm_Output_default_sort_order_setting Outputs the default sort order option on the settings page
Hm_Output_delete_prompt_setting Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_delete_search_icon Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_dev_content Output links to developer resources
Hm_Output_developer_doc_link Adds a link to the dev resources page to the folder list
Hm_Output_display_configured_feeds Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_display_configured_imap_servers Format configured IMAP servers for the servers page
Hm_Output_display_configured_jmap_servers Format configured JMAP servers for the servers page
Hm_Output_display_configured_pop3_servers Format a list of configured POP3 servers
Hm_Output_display_configured_smtp_servers Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_display_feeds_status Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_display_github_status Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_display_imap_status Format the IMAP status output on the info page
Hm_Output_display_pop3_status Format a POP3 status response row
Hm_Output_dynamic_login Outputs the login or logout form
Hm_Output_email_menu_content Output the E-mail section of the folder list
Hm_Output_enable_2fa_setting Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_enable_shortcut_setting Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_end_settings_form Ends the settings table
Hm_Output_feed_ids Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_feed_limit_setting Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_feed_since_setting Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_filter_all_email Format message headers for the All E-mail page
Hm_Output_filter_autocomplete_list Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_filter_combined_inbox Format message headers for the Everthing page
Hm_Output_filter_expanded_folder_data Format a list of subfolders
Hm_Output_filter_feed_folders Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_filter_feed_item_content Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_filter_feed_list_data Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_filter_feed_status_data Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_filter_flagged_data Format message headers for the Flagged page
Hm_Output_filter_folder_page Normal IMAP folder view
Hm_Output_filter_github_data Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_filter_github_event_detail Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_filter_github_status Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_filter_imap_advanced_search Format search results row
Hm_Output_filter_imap_folders Format the top level IMAP folders for the folder list
Hm_Output_filter_imap_search Format search results row
Hm_Output_filter_imap_status_data Format the status of an IMAP connection used on the info page
Hm_Output_filter_message_body Format a message part body for display
Hm_Output_filter_message_headers Format the message headers section of the message view
Hm_Output_filter_message_struct Format the message part section of the message view
Hm_Output_filter_pop3_folders Format POP3 folders for the folder list
Hm_Output_filter_pop3_message_content Format a POP3 message for display
Hm_Output_filter_pop3_message_list Format a list of POP3 messages
Hm_Output_filter_pop3_status_data Format POP3 status response data
Hm_Output_filter_saved_search_result Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_filter_sent_data Format message headers for the Sent E-mail page
Hm_Output_filter_service_select Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_filter_unread_data Format message headers for the Unread page
Hm_Output_filter_upload_file_details Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_filter_wp_notice_data Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_filter_wp_notification_data Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_flagged_since_setting Option for the "received since" date range for the Flagged page
Hm_Output_flagged_source_max_setting Option for the maximum number of messages per source for the Flagged page
Hm_Output_folder_list_content_end End of the content section of the folder list
Hm_Output_folder_list_content_start Start the folder list content
Hm_Output_folder_list_end Closes the folder list
Hm_Output_folder_list_start Start the folder list
Hm_Output_folders_archive_dialog Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_folders_content_start Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_folders_create_dialog Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_folders_delete_dialog Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_folders_draft_dialog Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_folders_page_link Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_folders_rename_dialog Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_folders_sent_dialog Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_folders_server_select Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_folders_trash_dialog Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_github_add_repo Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_github_connect_section Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_github_folders Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_github_limit_setting Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_github_since_setting Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_header_content Outputs HTML5 head tag content
Hm_Output_header_css Output CSS
Hm_Output_header_end Close the HTML5 head tag
Hm_Output_header_start Start the HTML5 document
Hm_Output_hello_world_ajax_content Another output module, this one is called from an AJAX request in site.js. AJAX requests need to use $this->out('name', 'value') to add to the JSON response. They name used must be whitelisted in the setup.php file under 'allowed_output'.
Hm_Output_hello_world_home_page This is an output modules that was assigned to the "home" page id. It outputs after the content_section_start core module, and outputs a div with "hello world" as a link to the hello world page
Hm_Output_hello_world_page_content This is an output module assigned to the hello_world page identifier (this is done in the setup.php file). This looks for the data sent from the Hm_Handler_hello_world_page_handler module and outputs it after the content_section_start module
Hm_Output_highlight_config_page Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_highlight_css Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_highlight_link Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_history_content Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_history_footer Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_history_heading Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_history_page_link Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_home_heading Output the heading for the home page
Hm_Output_home_password_dialogs Output password dialogs if no_password_save is active
Hm_Output_HTTP Output request responses using HTTP
Hm_Output_idle_time_setting Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_imap_custom_controls Format a custom list controls section
Hm_Output_imap_msg_icons_setting Option to enable/disable message part icons on the message view
Hm_Output_imap_per_page_setting Option to set the per page count for IMAP folder views
Hm_Output_imap_server_ids Output a hidden field with all the IMAP server ids
Hm_Output_imap_simple_msg_parts Option to enable/disable simple message structure on the message view
Hm_Output_imap_unflag_on_send_controls Option to unflag a message on reply
Hm_Output_info_heading Start the info section on the dev page
Hm_Output_info_page_link Adds a link to the info page to the folder list
Hm_Output_inline_message_flag Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_inline_message_setting Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_inline_message_style Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_js_data Outputs page details for the JS
Hm_Output_js_search_data Some inline JS used by the search page
Hm_Output_keyboard_shortcut_data Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_language_setting Option for the language setting
Hm_Output_ldap_auth_settings Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_ldap_contact_form_end Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_ldap_contact_form_start Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_ldap_form_car Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_ldap_form_displayname Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_ldap_form_emp_num Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_ldap_form_emp_type Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_ldap_form_fax Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_ldap_form_first_name Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_ldap_form_lang Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_ldap_form_last_name Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_ldap_form_locality Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_ldap_form_mail Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_ldap_form_mobile Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_ldap_form_org Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_ldap_form_org_dpt Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_ldap_form_org_unit Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_ldap_form_phone Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_ldap_form_postalcode Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_ldap_form_room Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_ldap_form_state Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_ldap_form_street Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_ldap_form_submit Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_ldap_form_title Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_ldap_form_uri Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_list_style_setting Outputs the list style option on the settings page
Hm_Output_loading_icon Outputs a load icon
Hm_Output_login Outputs the login or logout form
Hm_Output_login_end Outputs the end of the login or logout form
Hm_Output_login_start Outputs the start of the login or logout form
Hm_Output_logout_menu_item Outputs the logout link in the Main menu of the folder list
Hm_Output_mailto_handler_setting Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_main_menu_content Content for the Main menu section of the folder list
Hm_Output_main_menu_end Close the Main menu section of the folder list
Hm_Output_main_menu_start Start the Main menu section of the folder list
Hm_Output_message_end Close the message view content section
Hm_Output_message_list_end End a message list table
Hm_Output_message_list_heading Output the heading for a message list
Hm_Output_message_list_start Start the table for a message list
Hm_Output_message_start Starts the message view page
Hm_Output_Module Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_Modules Class to manage all the output modules
Hm_Output_move_copy_controls Add move/copy dialog to the message list controls
Hm_Output_msg_list_icons_setting Option to enable/disable message list icons
Hm_Output_msgs Display system messages
Hm_Output_nasa_connect_section Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_nasa_folders Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_no_folder_icon_setting Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_no_password_setting Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_notfound_content Not found content for a bad page request
Hm_Output_nux_dev_news Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_nux_help Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_nux_message_list_notice Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_page_js Output JS
Hm_Output_pgp_compose_controls Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_pgp_msg_controls Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_pgp_settings_end Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_pgp_settings_link Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_pgp_settings_private_key Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_pgp_settings_public_keys Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_pgp_settings_start Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_pop3_server_ids Output POP3 server ids
Hm_Output_prefetch_imap_folder_ids Output imap prefetch ids
Hm_Output_profile_content Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_profile_edit_form Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_profile_page_link Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_push_js_include Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_quick_add_dialog Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_quick_add_section Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_recaptcha_form Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_recaptcha_script Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_recover_settings_page Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_recover_settings_page_link Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_save_form Save settings page content
Hm_Output_save_reminder Unsaved data reminder
Hm_Output_save_search_icon Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_save_searches_form Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_search_content_end End of the search results content section
Hm_Output_search_content_start Start the search results content section
Hm_Output_search_folders Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_search_form_content Search form content
Hm_Output_search_form_end Finish the search form
Hm_Output_search_form_start Start the search form
Hm_Output_search_from_folder_list Simple search form for the folder list
Hm_Output_search_move_copy_controls Add move/copy dialog to the search page
Hm_Output_search_name_fld Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_search_results_table_end Closes the search results table
Hm_Output_sent_folder_link Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_sent_since_setting Option for the "received since" date range for the All E-mail page
Hm_Output_sent_source_max_setting Option for the maximum number of messages per source for the All E-mail page
Hm_Output_server_content_end Close the server content section
Hm_Output_server_content_start Start the content section for the servers page
Hm_Output_server_information Outputs server information
Hm_Output_server_status_end Close the status table used on the info page
Hm_Output_server_status_start Starts a status table used on the info page
Hm_Output_settings_menu_end Closes the Settings menu in the folder list
Hm_Output_settings_menu_start Start the Settings section of the folder list
Hm_Output_settings_save_link Save link for the Settings menu section of the folder list
Hm_Output_settings_servers_link Servers link for the Settings menu section of the folder list
Hm_Output_settings_site_link Site link for the Settings menu section of the folder list
Hm_Output_shortcut_edit_form Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_shortcuts_content Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_shortcuts_page_link Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_start_all_email_settings Start the E-mail section on the settings page.
Hm_Output_start_everything_settings Start the Everything section on the settings page
Hm_Output_start_feed_settings Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_start_flagged_settings Starts the Flagged section on the settings page
Hm_Output_start_general_settings Start the general settings section
Hm_Output_start_github_settings Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_start_page_setting Outputs the start page option on the settings page
Hm_Output_start_sent_settings Start the sent section on the settings page.
Hm_Output_start_settings_form Start the main form on the settings page
Hm_Output_start_shortcuts_page Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_start_unread_settings Start the Unread section on the settings page
Hm_Output_start_wordpress_settings Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_tag_bar
Hm_Output_tag_folders
Hm_Output_Test Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_text_only_setting Option to limit mail fromat to text only when possible (not defaulting to HTML)
Hm_Output_theme_css Include theme css
Hm_Output_theme_setting Theme setting
Hm_Output_timezone_setting Option for the timezone setting
Hm_Output_unread_feeds_included Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_unread_github_included_setting Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_unread_since_setting Option for the "received since" date range for the Unread page
Hm_Output_unread_source_max_setting Option for the maximum number of messages per source for the Unread page
Hm_Output_unread_wp_included_setting Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_update_search_icon Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_update_search_label_icon Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_user_list Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_vcalendar_add_output Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_welcome_dialog Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_wordpress_connect_section Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_wordpress_folders Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_Output_wordpress_since_setting Base class for output modules All modules that output data to a request must extend this class and define an output() method. It provides form validation, html sanitizing, and string translation services to modules
Hm_PHP_Session PHP Sessions that extend the base session class
Hm_PHP_Session_Data PHP session data methods
Hm_POP3
Hm_POP3 Connect to and interact with POP3 servers
Hm_POP3_Base Connect to and interact with POP3 servers
Hm_POP3_List POP3 connection manager
Hm_POP3_List
Hm_POP3_Uid_Cache Used to mark messages as "read"
Hm_Profiles
Hm_Redis Redis cache
Hm_Redis_Session This session class uses a Redis to manage session data. It does not use PHP session handlers at all and is a completely indenpendant session system.
Hm_Request Data request details
Hm_Request_Key Manage request keys for modules
Hm_Saved_Searches
Hm_Server_Wrapper
Hm_Session Base class for session management. All session interaction happens through classes that extend this.
Hm_Session_Setup Setup the session and authentication classes based on the site config
Hm_Site_Config_File File based site configuration
Hm_SMTP Connect to and interact with SMTP servers
Hm_SMTP_List
Hm_SMTP_List SMTP connection manager
Hm_Sodium_Compat
Hm_Sodium_PECL Support for libsodium PECL package, and the upcoming PHP 7.2 built in extension The 2 versions of libsodium differ in the following ways:
Hm_Sodium_PHP
Hm_Tags
Hm_Test_API_Curl
Hm_Test_Auth
Hm_Test_Core_Functions
Hm_Test_Core_Functions_Debug
Hm_Test_Core_Handler_Modules
Hm_Test_Core_Message_Functions
Hm_Test_Core_Message_List_Functions
Hm_Test_Core_Output_Modules TODO: add assertions to all tests
Hm_Test_Core_Output_Modules_Debug
Hm_Test_Crypt tests for Hm_Crypt
Hm_Test_Crypt_Base tests for Hm_Crypt
Hm_Test_DB tests for Hm_DB
Hm_Test_DB_Session tests for Hm_DB_Session
Hm_Test_Debug tests for Hm_Debug
Hm_Test_Debug_Page_Redirect
Hm_Test_Dispatch
Hm_Test_Elog tests for elog
Hm_Test_Format tests for Hm_Format_JSON and Hm_Format_HTML5
Hm_Test_Handler_Module tests for the Hm_Handler_Module class
Hm_Test_Handler_Module_Debug DEBUG_MODE tests for the Hm_Handler_Module class
Hm_Test_Hm_Cache tests for generica cache
Hm_Test_Hm_IMAP
Hm_Test_Hm_Memcache tests for Hm_Memcached
Hm_Test_Hm_Redis tests for Hm_Redis
Hm_Test_Memcached_Session tests for Hm_Memcached_Session
Hm_Test_Module_Exec tests for the module runner
Hm_Test_Module_Exec_Debug
Hm_Test_Module_Functions tests for the functional interface to modules
Hm_Test_Module_List
Hm_Test_Module_List_Functions
Hm_Test_Modules tests for the Hm_Modules trait
Hm_Test_Modules_Output tests for the Hm_Module_Output trait
Hm_Test_Msgs tests for Hm_Msgs
Hm_Test_Oauth2
Hm_Test_Output tests for Hm_Output_HTTP
Hm_Test_Output_Module tests for the Hm_Output_Module class
Hm_Test_PHP_Session tests for Hm_PHP_Session
Hm_Test_Redis_Session tests for Hm_Redis_Session
Hm_Test_Request tests for the Hm_Request class
Hm_Test_Request_Key tests for Hm_Request_Key
Hm_Test_Server
Hm_Test_Server_List tests for the Hm_Server_List trait
Hm_Test_Session_Functions
Hm_Test_Site_Config_File tests for Hm_Site_Config_File
Hm_Test_Transform
Hm_Test_Uid_Cache tests for Hm_Uid_Cache
Hm_Test_User_Config_DB tests for Hm_User_Config_DB
Hm_Test_User_Config_File tests for Hm_User_Config_File
Hm_Test_User_Config_Functions
Hm_Test_Webdav_Formats
Hm_Transform binary safe wrapper around json encode/decode using base64
Hm_User_Config_DB DB based user settings
Hm_User_Config_File File based user settings
Hm_VCard Class for parsing vCard data
HTML5
HTML5TreeConstructer
HTMLPurifier Facade that coordinates HTML Purifier's subsystems in order to purify HTML.
HTMLPurifier_Arborize Converts a stream of HTMLPurifier_Token into an HTMLPurifier_Node, and back again.
HTMLPurifier_AttrCollections Defines common attribute collections that modules reference
HTMLPurifier_AttrDef Base class for all validating attribute definitions.
HTMLPurifier_AttrDef_Clone Dummy AttrDef that mimics another AttrDef, BUT it generates clones with make.
HTMLPurifier_AttrDef_CSS Validates the HTML attribute style, otherwise known as CSS.
HTMLPurifier_AttrDef_CSS_AlphaValue Validates a number as defined by the CSS spec.
HTMLPurifier_AttrDef_CSS_Background Validates shorthand CSS property background.
HTMLPurifier_AttrDef_CSS_BackgroundPosition Validates the value of background-position.
HTMLPurifier_AttrDef_CSS_Border Validates the border property as defined by CSS.
HTMLPurifier_AttrDef_CSS_Color Validates Color as defined by CSS.
HTMLPurifier_AttrDef_CSS_Composite Allows multiple validators to attempt to validate attribute.
HTMLPurifier_AttrDef_CSS_DenyElementDecorator Decorator which enables CSS properties to be disabled for specific elements.
HTMLPurifier_AttrDef_CSS_Filter Microsoft's proprietary filter: CSS property
HTMLPurifier_AttrDef_CSS_Font Validates shorthand CSS property font.
HTMLPurifier_AttrDef_CSS_FontFamily Validates a font family list according to CSS spec
HTMLPurifier_AttrDef_CSS_Ident Validates based on {ident} CSS grammar production
HTMLPurifier_AttrDef_CSS_ImportantDecorator Decorator which enables !important to be used in CSS values.
HTMLPurifier_AttrDef_CSS_Length Represents a Length as defined by CSS.
HTMLPurifier_AttrDef_CSS_ListStyle Validates shorthand CSS property list-style.
HTMLPurifier_AttrDef_CSS_Multiple Framework class for strings that involve multiple values.
HTMLPurifier_AttrDef_CSS_Number Validates a number as defined by the CSS spec.
HTMLPurifier_AttrDef_CSS_Percentage Validates a Percentage as defined by the CSS spec.
HTMLPurifier_AttrDef_CSS_TextDecoration Validates the value for the CSS property text-decoration
HTMLPurifier_AttrDef_CSS_URI Validates a URI in CSS syntax, which uses url('http://example.com')
HTMLPurifier_AttrDef_Enum Validates a keyword against a list of valid values.
HTMLPurifier_AttrDef_HTML_Bool Validates a boolean attribute
HTMLPurifier_AttrDef_HTML_Class Implements special behavior for class attribute (normally NMTOKENS)
HTMLPurifier_AttrDef_HTML_Color Validates a color according to the HTML spec.
HTMLPurifier_AttrDef_HTML_FrameTarget Special-case enum attribute definition that lazy loads allowed frame targets
HTMLPurifier_AttrDef_HTML_ID Validates the HTML attribute ID.
HTMLPurifier_AttrDef_HTML_Length Validates the HTML type length (not to be confused with CSS's length).
HTMLPurifier_AttrDef_HTML_LinkTypes Validates a rel/rev link attribute against a directive of allowed values
HTMLPurifier_AttrDef_HTML_MultiLength Validates a MultiLength as defined by the HTML spec.
HTMLPurifier_AttrDef_HTML_Nmtokens Validates contents based on NMTOKENS attribute type.
HTMLPurifier_AttrDef_HTML_Pixels Validates an integer representation of pixels according to the HTML spec.
HTMLPurifier_AttrDef_Integer Validates an integer.
HTMLPurifier_AttrDef_Lang Validates the HTML attribute lang, effectively a language code.
HTMLPurifier_AttrDef_Switch Decorator that, depending on a token, switches between two definitions.
HTMLPurifier_AttrDef_Text Validates arbitrary text according to the HTML spec.
HTMLPurifier_AttrDef_URI Validates a URI as defined by RFC 3986.
HTMLPurifier_AttrDef_URI_Email Base class for all validating attribute definitions.
HTMLPurifier_AttrDef_URI_Email_SimpleCheck Primitive email validation class based on the regexp found at http://www.regular-expressions.info/email.html
HTMLPurifier_AttrDef_URI_Host Validates a host according to the IPv4, IPv6 and DNS (future) specifications.
HTMLPurifier_AttrDef_URI_IPv4 Validates an IPv4 address
HTMLPurifier_AttrDef_URI_IPv6 Validates an IPv6 address.
HTMLPurifier_AttrTransform Processes an entire attribute array for corrections needing multiple values.
HTMLPurifier_AttrTransform_Background Pre-transform that changes proprietary background attribute to CSS.
HTMLPurifier_AttrTransform_BdoDir Post-trasnform that ensures that bdo tags have the dir attribute set.
HTMLPurifier_AttrTransform_BgColor Pre-transform that changes deprecated bgcolor attribute to CSS.
HTMLPurifier_AttrTransform_BoolToCSS Pre-transform that changes converts a boolean attribute to fixed CSS
HTMLPurifier_AttrTransform_Border Pre-transform that changes deprecated border attribute to CSS.
HTMLPurifier_AttrTransform_EnumToCSS Generic pre-transform that converts an attribute with a fixed number of values (enumerated) to CSS.
HTMLPurifier_AttrTransform_ImgRequired Transform that supplies default values for the src and alt attributes in img tags, as well as prevents the img tag from being removed because of a missing alt tag. This needs to be registered as both a pre and post attribute transform.
HTMLPurifier_AttrTransform_ImgSpace Pre-transform that changes deprecated hspace and vspace attributes to CSS
HTMLPurifier_AttrTransform_Input Performs miscellaneous cross attribute validation and filtering for input elements. This is meant to be a post-transform.
HTMLPurifier_AttrTransform_Lang Post-transform that copies lang's value to xml:lang (and vice-versa)
HTMLPurifier_AttrTransform_Length Class for handling width/height length attribute transformations to CSS
HTMLPurifier_AttrTransform_Name Pre-transform that changes deprecated name attribute to ID if necessary
HTMLPurifier_AttrTransform_NameSync Post-transform that performs validation to the name attribute; if it is present with an equivalent id attribute, it is passed through; otherwise validation is performed.
HTMLPurifier_AttrTransform_Nofollow Adds rel="nofollow" to all outbound links. This transform is only attached if Attr.Nofollow is TRUE.
HTMLPurifier_AttrTransform_SafeEmbed Processes an entire attribute array for corrections needing multiple values.
HTMLPurifier_AttrTransform_SafeObject Writes default type for all objects. Currently only supports flash.
HTMLPurifier_AttrTransform_SafeParam Validates name/value pairs in param tags to be used in safe objects. This will only allow name values it recognizes, and pre-fill certain attributes with required values.
HTMLPurifier_AttrTransform_ScriptRequired Implements required attribute stipulation for <script>
HTMLPurifier_AttrTransform_TargetBlank Adds target="blank" to all outbound links. This transform is only attached if Attr.TargetBlank is TRUE. This works regardless of whether or not Attr.AllowedFrameTargets
HTMLPurifier_AttrTransform_TargetNoopener Adds rel="noopener" to any links which target a different window than the current one. This is used to prevent malicious websites from silently replacing the original window, which could be used to do phishing.
HTMLPurifier_AttrTransform_TargetNoreferrer Adds rel="noreferrer" to any links which target a different window than the current one. This is used to prevent malicious websites from silently replacing the original window, which could be used to do phishing.
HTMLPurifier_AttrTransform_Textarea Sets height/width defaults for <textarea>
HTMLPurifier_AttrTypes Provides lookup array of attribute types to HTMLPurifier_AttrDef objects
HTMLPurifier_AttrValidator Validates the attributes of a token. Doesn't manage required attributes very well. The only reason we factored this out was because RemoveForeignElements also needed it besides ValidateAttributes.
HTMLPurifier_Bootstrap Bootstrap class that contains meta-functionality for HTML Purifier such as the autoload function.
HTMLPurifier_ChildDef Defines allowed child nodes and validates nodes against it.
HTMLPurifier_ChildDef_Chameleon Definition that uses different definitions depending on context.
HTMLPurifier_ChildDef_Custom Custom validation class, accepts DTD child definitions
HTMLPurifier_ChildDef_Empty Definition that disallows all elements.
HTMLPurifier_ChildDef_List Definition for list containers ul and ol.
HTMLPurifier_ChildDef_Optional Definition that allows a set of elements, and allows no children.
HTMLPurifier_ChildDef_Required Definition that allows a set of elements, but disallows empty children.
HTMLPurifier_ChildDef_StrictBlockquote Takes the contents of blockquote when in strict and reformats for validation.
HTMLPurifier_ChildDef_Table Definition for tables. The general idea is to extract out all of the essential bits, and then reconstruct it later.
HTMLPurifier_Config Configuration object that triggers customizable behavior.
HTMLPurifier_ConfigSchema Configuration definition, defines directives and their defaults.
HTMLPurifier_ConfigSchema_Builder_ConfigSchema Converts HTMLPurifier_ConfigSchema_Interchange to our runtime representation used to perform checks on user configuration.
HTMLPurifier_ConfigSchema_Builder_Xml Converts HTMLPurifier_ConfigSchema_Interchange to an XML format, which can be further processed to generate documentation.
HTMLPurifier_ConfigSchema_Exception Exceptions related to configuration schema
HTMLPurifier_ConfigSchema_Interchange Generic schema interchange format that can be converted to a runtime representation (HTMLPurifier_ConfigSchema) or HTML documentation. Members are completely validated.
HTMLPurifier_ConfigSchema_Interchange_Directive Interchange component class describing configuration directives.
HTMLPurifier_ConfigSchema_Interchange_Id Represents a directive ID in the interchange format.
HTMLPurifier_ConfigSchema_InterchangeBuilder
HTMLPurifier_ConfigSchema_Validator Performs validations on HTMLPurifier_ConfigSchema_Interchange
HTMLPurifier_ConfigSchema_ValidatorAtom Fluent interface for validating the contents of member variables.
HTMLPurifier_ContentSets
HTMLPurifier_Context Registry object that contains information about the current context.
HTMLPurifier_CSSDefinition Defines allowed CSS attributes and what their values are.
HTMLPurifier_Definition Super-class for definition datatype objects, implements serialization functions for the class.
HTMLPurifier_DefinitionCache Abstract class representing Definition cache managers that implements useful common methods and is a factory.
HTMLPurifier_DefinitionCache_Decorator Abstract class representing Definition cache managers that implements useful common methods and is a factory.
HTMLPurifier_DefinitionCache_Decorator_Cleanup Definition cache decorator class that cleans up the cache whenever there is a cache miss.
HTMLPurifier_DefinitionCache_Decorator_Memory Definition cache decorator class that saves all cache retrievals to PHP's memory; good for unit tests or circumstances where there are lots of configuration objects floating around.
HTMLPurifier_DefinitionCache_Null Null cache object to use when no caching is on.
HTMLPurifier_DefinitionCache_Serializer Abstract class representing Definition cache managers that implements useful common methods and is a factory.
HTMLPurifier_DefinitionCacheFactory Responsible for creating definition caches.
HTMLPurifier_Doctype Represents a document type, contains information on which modules need to be loaded.
HTMLPurifier_DoctypeRegistry
HTMLPurifier_ElementDef Structure that stores an HTML element definition. Used by HTMLPurifier_HTMLDefinition and HTMLPurifier_HTMLModule.
HTMLPurifier_Encoder A UTF-8 specific character encoder that handles cleaning and transforming.
HTMLPurifier_EntityLookup Object that provides entity lookup table from entity name to character
HTMLPurifier_EntityParser Handles referencing and derefencing character entities
HTMLPurifier_ErrorCollector Error collection class that enables HTML Purifier to report HTML problems back to the user
HTMLPurifier_ErrorStruct Records errors for particular segments of an HTML document such as tokens, attributes or CSS properties. They can contain error structs (which apply to components of what they represent), but their main purpose is to hold errors applying to whatever struct is being used.
HTMLPurifier_Exception Global exception class for HTML Purifier; any exceptions we throw are from here.
HTMLPurifier_Filter Represents a pre or post processing filter on HTML Purifier's output
HTMLPurifier_Filter_ExtractStyleBlocks This filter extracts <style> blocks from input HTML, cleans them up using CSSTidy, and then places them in $purifier->context->get('StyleBlocks') so they can be used elsewhere in the document.
HTMLPurifier_Filter_YouTube Represents a pre or post processing filter on HTML Purifier's output
HTMLPurifier_Generator Generates HTML from tokens.
HTMLPurifier_HTMLDefinition Definition of the purified HTML that describes allowed children, attributes, and many other things.
HTMLPurifier_HTMLModule Represents an XHTML 1.1 module, with information on elements, tags and attributes.
HTMLPurifier_HTMLModule_Bdo XHTML 1.1 Bi-directional Text Module, defines elements that declare directionality of content. Text Extension Module.
HTMLPurifier_HTMLModule_CommonAttributes Represents an XHTML 1.1 module, with information on elements, tags and attributes.
HTMLPurifier_HTMLModule_Edit XHTML 1.1 Edit Module, defines editing-related elements. Text Extension Module.
HTMLPurifier_HTMLModule_Forms XHTML 1.1 Forms module, defines all form-related elements found in HTML 4.
HTMLPurifier_HTMLModule_Hypertext XHTML 1.1 Hypertext Module, defines hypertext links. Core Module.
HTMLPurifier_HTMLModule_Iframe XHTML 1.1 Iframe Module provides inline frames.
HTMLPurifier_HTMLModule_Image XHTML 1.1 Image Module provides basic image embedding.
HTMLPurifier_HTMLModule_Legacy XHTML 1.1 Legacy module defines elements that were previously deprecated.
HTMLPurifier_HTMLModule_List XHTML 1.1 List Module, defines list-oriented elements. Core Module.
HTMLPurifier_HTMLModule_Name Represents an XHTML 1.1 module, with information on elements, tags and attributes.
HTMLPurifier_HTMLModule_Nofollow Module adds the nofollow attribute transformation to a tags. It is enabled by HTML.Nofollow
HTMLPurifier_HTMLModule_NonXMLCommonAttributes Represents an XHTML 1.1 module, with information on elements, tags and attributes.
HTMLPurifier_HTMLModule_Object XHTML 1.1 Object Module, defines elements for generic object inclusion
HTMLPurifier_HTMLModule_Presentation XHTML 1.1 Presentation Module, defines simple presentation-related markup. Text Extension Module.
HTMLPurifier_HTMLModule_Proprietary Module defines proprietary tags and attributes in HTML.
HTMLPurifier_HTMLModule_Ruby XHTML 1.1 Ruby Annotation Module, defines elements that indicate short runs of text alongside base text for annotation or pronounciation.
HTMLPurifier_HTMLModule_SafeEmbed A "safe" embed module. See SafeObject. This is a proprietary element.
HTMLPurifier_HTMLModule_SafeObject A "safe" object module. In theory, objects permitted by this module will be safe, and untrusted users can be allowed to embed arbitrary flash objects (maybe other types too, but only Flash is supported as of right now).
HTMLPurifier_HTMLModule_SafeScripting A "safe" script module. No inline JS is allowed, and pointed to JS files must match whitelist.
HTMLPurifier_HTMLModule_Scripting XHTML 1.1 Scripting module, defines elements that are used to contain information pertaining to executable scripts or the lack of support for executable scripts.
HTMLPurifier_HTMLModule_StyleAttribute XHTML 1.1 Edit Module, defines editing-related elements. Text Extension Module.
HTMLPurifier_HTMLModule_Tables XHTML 1.1 Tables Module, fully defines accessible table elements.
HTMLPurifier_HTMLModule_Target XHTML 1.1 Target Module, defines target attribute in link elements.
HTMLPurifier_HTMLModule_TargetBlank Module adds the target=blank attribute transformation to a tags. It is enabled by HTML.TargetBlank
HTMLPurifier_HTMLModule_TargetNoopener Module adds the target-based noopener attribute transformation to a tags. It is enabled by HTML.TargetNoopener
HTMLPurifier_HTMLModule_TargetNoreferrer Module adds the target-based noreferrer attribute transformation to a tags. It is enabled by HTML.TargetNoreferrer
HTMLPurifier_HTMLModule_Text XHTML 1.1 Text Module, defines basic text containers. Core Module.
HTMLPurifier_HTMLModule_Tidy Abstract class for a set of proprietary modules that clean up (tidy) poorly written HTML.
HTMLPurifier_HTMLModule_Tidy_Name Name is deprecated, but allowed in strict doctypes, so onl
HTMLPurifier_HTMLModule_Tidy_Proprietary Abstract class for a set of proprietary modules that clean up (tidy) poorly written HTML.
HTMLPurifier_HTMLModule_Tidy_Strict Abstract class for a set of proprietary modules that clean up (tidy) poorly written HTML.
HTMLPurifier_HTMLModule_Tidy_Transitional Abstract class for a set of proprietary modules that clean up (tidy) poorly written HTML.
HTMLPurifier_HTMLModule_Tidy_XHTML Abstract class for a set of proprietary modules that clean up (tidy) poorly written HTML.
HTMLPurifier_HTMLModule_Tidy_XHTMLAndHTML4 Abstract class for a set of proprietary modules that clean up (tidy) poorly written HTML.
HTMLPurifier_HTMLModule_XMLCommonAttributes Represents an XHTML 1.1 module, with information on elements, tags and attributes.
HTMLPurifier_HTMLModuleManager
HTMLPurifier_IDAccumulator Component of HTMLPurifier_AttrContext that accumulates IDs to prevent dupes
HTMLPurifier_Injector Injects tokens into the document while parsing for well-formedness.
HTMLPurifier_Injector_AutoParagraph Injector that auto paragraphs text in the root node based on double-spacing.
HTMLPurifier_Injector_DisplayLinkURI Injector that displays the URL of an anchor instead of linking to it, in addition to showing the text of the link.
HTMLPurifier_Injector_Linkify Injector that converts http, https and ftp text URLs to actual links.
HTMLPurifier_Injector_PurifierLinkify Injector that converts configuration directive syntax %Namespace.Directive to links
HTMLPurifier_Injector_RemoveEmpty Injects tokens into the document while parsing for well-formedness.
HTMLPurifier_Injector_RemoveSpansWithoutAttributes Injector that removes spans with no attributes
HTMLPurifier_Injector_SafeObject Adds important param elements to inside of object in order to make things safe.
HTMLPurifier_Language Represents a language and defines localizable string formatting and other functions, as well as the localized messages for HTML Purifier.
HTMLPurifier_LanguageFactory Class responsible for generating HTMLPurifier_Language objects, managing caching and fallbacks.
HTMLPurifier_Length Represents a measurable length, with a string numeric magnitude and a unit. This object is immutable.
HTMLPurifier_Lexer Forgivingly lexes HTML (SGML-style) markup into tokens.
HTMLPurifier_Lexer_DirectLex Our in-house implementation of a parser.
HTMLPurifier_Lexer_DOMLex Parser that uses PHP 5's DOM extension (part of the core).
HTMLPurifier_Lexer_PH5P Experimental HTML5-based parser using Jeroen van der Meer's PH5P library.
HTMLPurifier_Node Abstract base node class that all others inherit from.
HTMLPurifier_Node_Comment Concrete comment node class.
HTMLPurifier_Node_Element Concrete element node class.
HTMLPurifier_Node_Text Concrete text token class.
HTMLPurifier_PercentEncoder Class that handles operations involving percent-encoding in URIs.
HTMLPurifier_Printer
HTMLPurifier_Printer_ConfigForm
HTMLPurifier_Printer_ConfigForm_bool Bool form field printer
HTMLPurifier_Printer_ConfigForm_default Swiss-army knife configuration form field printer
HTMLPurifier_Printer_ConfigForm_NullDecorator Printer decorator for directives that accept null
HTMLPurifier_Printer_CSSDefinition
HTMLPurifier_Printer_HTMLDefinition
HTMLPurifier_PropertyList Generic property list implementation
HTMLPurifier_PropertyListIterator Property list iterator. Do not instantiate this class directly.
HTMLPurifier_Queue A simple array-backed queue, based off of the classic Okasaki persistent amortized queue. The basic idea is to maintain two stacks: an input stack and an output stack. When the output stack runs out, reverse the input stack and use it as the output stack.
HTMLPurifier_Strategy Supertype for classes that define a strategy for modifying/purifying tokens.
HTMLPurifier_Strategy_Composite Composite strategy that runs multiple strategies on tokens.
HTMLPurifier_Strategy_Core Core strategy composed of the big four strategies.
HTMLPurifier_Strategy_FixNesting Takes a well formed list of tokens and fixes their nesting.
HTMLPurifier_Strategy_MakeWellFormed Takes tokens makes them well-formed (balance end tags, etc.)
HTMLPurifier_Strategy_RemoveForeignElements Removes all unrecognized tags from the list of tokens.
HTMLPurifier_Strategy_ValidateAttributes Validate all attributes in the tokens.
HTMLPurifier_StringHash This is in almost every respect equivalent to an array except that it keeps track of which keys were accessed.
HTMLPurifier_StringHashParser Parses string hash files. File format is as such:
HTMLPurifier_TagTransform Defines a mutation of an obsolete tag into a valid tag.
HTMLPurifier_TagTransform_Font Transforms FONT tags to the proper form (SPAN with CSS styling)
HTMLPurifier_TagTransform_Simple Simple transformation, just change tag name to something else, and possibly add some styling. This will cover most of the deprecated tag cases.
HTMLPurifier_Token Abstract base token class that all others inherit from.
HTMLPurifier_Token_Comment Concrete comment token class. Generally will be ignored.
HTMLPurifier_Token_Empty Concrete empty token class.
HTMLPurifier_Token_End Concrete end token class.
HTMLPurifier_Token_Start Concrete start token class.
HTMLPurifier_Token_Tag Abstract class of a tag token (start, end or empty), and its behavior.
HTMLPurifier_Token_Text Concrete text token class.
HTMLPurifier_TokenFactory Factory for token generation.
HTMLPurifier_UnitConverter Class for converting between different unit-lengths as specified by CSS.
HTMLPurifier_URI HTML Purifier's internal representation of a URI.
HTMLPurifier_URIDefinition Super-class for definition datatype objects, implements serialization functions for the class.
HTMLPurifier_URIFilter Chainable filters for custom URI processing.
HTMLPurifier_URIFilter_DisableExternal Chainable filters for custom URI processing.
HTMLPurifier_URIFilter_DisableExternalResources Chainable filters for custom URI processing.
HTMLPurifier_URIFilter_DisableResources Chainable filters for custom URI processing.
HTMLPurifier_URIFilter_HostBlacklist Chainable filters for custom URI processing.
HTMLPurifier_URIFilter_MakeAbsolute Chainable filters for custom URI processing.
HTMLPurifier_URIFilter_Munge Chainable filters for custom URI processing.
HTMLPurifier_URIFilter_SafeIframe Implements safety checks for safe iframes.
HTMLPurifier_URIParser Parses a URI into the components and fragment identifier as specified by RFC 3986.
HTMLPurifier_URIScheme Validator for the components of a URI for a specific scheme
HTMLPurifier_URIScheme_data Implements data: URI for base64 encoded images supported by GD.
HTMLPurifier_URIScheme_file Validates file as defined by RFC 1630 and RFC 1738.
HTMLPurifier_URIScheme_ftp Validates ftp (File Transfer Protocol) URIs as defined by generic RFC 1738.
HTMLPurifier_URIScheme_http Validates http (HyperText Transfer Protocol) as defined by RFC 2616
HTMLPurifier_URIScheme_https Validates https (Secure HTTP) according to http scheme.
HTMLPurifier_URIScheme_mailto Validates mailto (for E-mail) according to RFC 2368
HTMLPurifier_URIScheme_news Validates news (Usenet) as defined by generic RFC 1738
HTMLPurifier_URIScheme_nntp Validates nntp (Network News Transfer Protocol) as defined by generic RFC 1738
HTMLPurifier_URIScheme_tel Validates tel (for phone numbers).
HTMLPurifier_URISchemeRegistry Registry for retrieving specific URI scheme validator objects.
HTMLPurifier_VarParser Parses string representations into their corresponding native PHP variable type. The base implementation does a simple type-check.
HTMLPurifier_VarParser_Flexible Performs safe variable parsing based on types which can be used by users. This may not be able to represent all possible data inputs, however.
HTMLPurifier_VarParser_Native This variable parser uses PHP's internal code engine. Because it does this, it can represent all inputs; however, it is dangerous and cannot be used by users.
HTMLPurifier_VarParserException Exception type for HTMLPurifier_VarParser
HTMLPurifier_Zipper A zipper is a purely-functional data structure which contains a focus that can be efficiently manipulated. It is known as a "one-hole context". This mutable variant implements a zipper for a list as a pair of two arrays, laid out as follows:
HTMLToText
Memcached
Nux_Quick_Services
Output_Test
Parsedown
Redis
Test_Uid_Cache
TypeError

Constants

APOD_URL

APOD_URL ='https://api.nasa.gov/planetary/apod?concept_tags=True&api_key=%s'

APP_PATH

APP_PATH =''

GIT VERSION: 10813

Some of the following constants are automatically filled in when the build process is run. If you change them in site/index.php and rerun the build process your changes will be lost

APP_PATH absolute path to the php files of the app DEBUG_MODE flag to enable easier debugging and development CACHE_ID unique string to bust js/css browser caching for a new build SITE_ID random site id used for page keys

APP_PATH

APP_PATH =dirname(dirname(__FILE__)) . '/'

APP_PATH

APP_PATH =dirname(dirname(dirname(__FILE__))) . '/'

APP_PATH

APP_PATH =dirname(dirname(dirname(__FILE__))) . '/'

APP_PATH

APP_PATH =dirname(dirname(__FILE__)) . '/'

APP_PATH

APP_PATH =dirname(dirname(__FILE__)) . '/'

APP_PATH

APP_PATH ='/home/jason/cypht/'

GIT VERSION: 10813

Some of the following constants are automatically filled in when the build process is run. If you change them in site/index.php and rerun the build process your changes will be lost

APP_PATH absolute path to the php files of the app DEBUG_MODE flag to enable easier debugging and development CACHE_ID unique string to bust js/css browser caching for a new build SITE_ID random site id used for page keys

APP_PATH

APP_PATH =dirname(dirname(__FILE__)) . '/'

APP_PATH

APP_PATH =dirname(dirname(__FILE__)) . '/'

CACHE_ID

CACHE_ID ='asdf'

CACHE_ID

CACHE_ID =''

CACHE_ID

CACHE_ID ='hj31P37K6K7aqirRx4FVd9y%2FDhTWm43Roy8x2Y7pwd0%3D'

CODE128_A

CODE128_A =1

CODE128_B

CODE128_B =2

CODE128_C

CODE128_C =3

CONFIG_FILE

CONFIG_FILE =APP_PATH . 'hm3.rc'

CONFIG_FILE

CONFIG_FILE =APP_PATH . 'hm3.rc'

CONFIG_FILE

CONFIG_FILE =APP_PATH . 'hm3.rc'

CONFIG_FILE

CONFIG_FILE =APP_PATH . 'hm3.rc'

CONFIG_FILE

CONFIG_FILE =APP_PATH . 'hm3.rc'

CSS_HASH

CSS_HASH =''

CSS_HASH

CSS_HASH ='foo'

CSS_HASH

CSS_HASH ='sha512-cU89IIHJhedGrdAkflANYEaIvjw5vBT1UD0cdlD3GWRXfX6Ic4icpCuSLqteG2cVuRxTi+GDBS+ulxxnk9HgSw=='

DEBUG_MODE

DEBUG_MODE =true

DEBUG_MODE

DEBUG_MODE =false

DEBUG_MODE

DEBUG_MODE =true

DEBUG_MODE

DEBUG_MODE =false

DEBUG_MODE

DEBUG_MODE =true

DEBUG_MODE

DEBUG_MODE =false

DEBUG_MODE

DEBUG_MODE =true

DEBUG_MODE

DEBUG_MODE =false

DEBUG_MODE

DEBUG_MODE =true

DEBUG_MODE

DEBUG_MODE =false

DEBUG_MODE

DEBUG_MODE =true

DEBUG_MODE

DEBUG_MODE =false

DEBUG_MODE

DEBUG_MODE =false

DEBUG_MODE

DEBUG_MODE =true

DEBUG_MODE

DEBUG_MODE =false

DEBUG_MODE

DEBUG_MODE =false

DEFAULT_PER_SOURCE

DEFAULT_PER_SOURCE =20

DEFAULT_SEARCH_FLD

DEFAULT_SEARCH_FLD ='TEXT'

DEFAULT_SINCE

DEFAULT_SINCE ='-1 week'

HTMLPURIFIER_PREFIX

HTMLPURIFIER_PREFIX =realpath(dirname(__FILE__) . '/..')

HTMLPURIFIER_PREFIX

HTMLPURIFIER_PREFIX =dirname(__FILE__)

IMAP_TEST

IMAP_TEST =true

JS_HASH

JS_HASH ='sha512-DgyHZu0gKOCSn2w2RHeqO2by2sWExHy3MJtflzBbHBWGcGdcO5Lv385q5u78oJ9p/jvEK/iknBottKfeXkE3tA=='

JS_HASH

JS_HASH ='foo'

JS_HASH

JS_HASH =''

LIBSODIUM

LIBSODIUM =false

LIBSODIUM

LIBSODIUM =false

MAX_PER_SOURCE

MAX_PER_SOURCE =1000

PHP_EOL

PHP_EOL ="\n"

PHP_VERSION_ID

PHP_VERSION_ID =$RandomCompatversion[0] * 10000 + $RandomCompatversion[1] * 100 + $RandomCompatversion[2]

RANDOM_COMPAT_READ_BUFFER

RANDOM_COMPAT_READ_BUFFER =8

RANDOM_COMPAT_READ_BUFFER

RANDOM_COMPAT_READ_BUFFER =8

SITE_ID

SITE_ID ='randomid'

SITE_ID

SITE_ID ='WdsiUDeDsgfeD9BPI8Zc7Rkky%2FeM450G1nxu7cE2CDr3rxN7sjqjIWL0AaJT3qnm9VW7sRpDctM%2FA6NYaLWu%2Bw%3D%3D'

SITE_ID

SITE_ID =''

VENDOR_PATH

VENDOR_PATH =APP_PATH . 'vendor/'

VENDOR_PATH

VENDOR_PATH =APP_PATH . 'vendor/'

VENDOR_PATH

VENDOR_PATH =APP_PATH . 'vendor/'

VENDOR_PATH

VENDOR_PATH =APP_PATH . 'vendor/'

VENDOR_PATH

VENDOR_PATH =APP_PATH . 'vendor/'

VENDOR_PATH

VENDOR_PATH =APP_PATH . 'vendor/'

VENDOR_PATH

VENDOR_PATH =APP_PATH . 'vendor/'

VENDOR_PATH

VENDOR_PATH =APP_PATH . 'vendor/'

VENDOR_PATH

VENDOR_PATH =APP_PATH . 'vendor/'

VERSION

VERSION =0.1

WEB_ROOT

WEB_ROOT =''

WEB_ROOT

WEB_ROOT =''

WEB_ROOT

WEB_ROOT =''

WEB_ROOT

WEB_ROOT =''

WEB_ROOT

WEB_ROOT =''

WEB_ROOT

WEB_ROOT =''

WEB_ROOT

WEB_ROOT =''

WEB_ROOT

WEB_ROOT =''

WEB_ROOT

WEB_ROOT =''

WPCOM_NOTICE_URL

WPCOM_NOTICE_URL ='https://public-api.wordpress.com/rest/v1/notifications/'

WPCOM_NOTICES_URL

WPCOM_NOTICES_URL ='https://public-api.wordpress.com/rest/v1/notifications/?number=20&fields=id,type,unread,subject,timestamp'

WPCOM_READ_URL

WPCOM_READ_URL ='https://public-api.wordpress.com/rest/v1.1/notifications/read'

Functions

__autoload()

__autoload(  $class)

Parameters

$class

add_attached_images()

add_attached_images(  $txt,  $uid,  $struct,  $imap)

Parameters

$txt
$uid
$struct
$imap

add_handler()

add_handler(  $page,string  $mod,boolean  $logged_in,string  $source = false,string  $marker = false,string  $placement = 'after',boolean  $queue = true): void

Add an input handler module to a specific page

Parameters

$page
string $mod

name of the module to add

boolean $logged_in

true if the module should only fire when logged in

string $source

the module set containing the module code

string $marker

the module name used to determine where to insert

string $placement

"before" or "after" the $marker module name

boolean $queue

true if the module should be queued and retryed on failure

add_module_to_all_pages()

add_module_to_all_pages(string  $type,string  $mod,boolean  $logged_in,string  $source,string  $marker,string  $placement): void

Add an input or output module to all possible pages

Parameters

string $type

either output or handler

string $mod

name of the module to add

boolean $logged_in

true if the module should only fire when logged in

string $source

the module set containing the module code

string $marker

the module name used to determine where to insert

string $placement

"before" or "after" the $marker module name

add_output()

add_output(  $page,string  $mod,boolean  $logged_in,string  $source = false,string  $marker = false,string  $placement = 'after',boolean  $queue = true): void

Add an output module to a specific page

Parameters

$page
string $mod

name of the module to add

boolean $logged_in

true if the module should only fire when logged in

string $source

the module set containing the module code

string $marker

the module name used to determine where to insert

string $placement

"before" or "after" the $marker module name

boolean $queue

true if the module should be queued and retryed on failure

addr_parse()

addr_parse(  $str)

Parameters

$str

addr_split()

addr_split(  $str,  $seps = array(',', ';'))

Parameters

$str
$seps

address_from_url()

address_from_url(  $str)

Parameters

$str

admin_users_setting()

admin_users_setting(  $current)

Parameters

$current

apod_date_form()

apod_date_form(  $date,  $output_mod)

Parameters

$date
$output_mod

app_data_dir_setting()

app_data_dir_setting(  $current)

Parameters

$current

app_name_setting()

app_name_setting(  $current)

Parameters

$current

attach_file()

attach_file(  $content,  $file,  $filepath,  $draft_id,  $mod)

Parameters

$content
$file
$filepath
$draft_id
$mod

attachment_dir_setting()

attachment_dir_setting(  $current)

Parameters

$current

auth_type_setting()

auth_type_setting(  $selected = false)

Parameters

$selected

backup_2fa_callback()

backup_2fa_callback(  $val)

Parameters

$val

backup_codes()

backup_codes(  $config)

Parameters

$config

base32_encode_str()

base32_encode_str(  $str)

Parameters

$str

build_config()

build_config(): void

Entry point into the configuration process

build_contact_detail()

build_contact_detail(  $output_mod,  $contact,  $id)

Parameters

$output_mod
$contact
$id

build_github_subject()

build_github_subject(  $event,  $output_mod)

Parameters

$event
$output_mod

build_integrity_hash()

build_integrity_hash(  $data)

build sub-resource integrity hash

Parameters

$data

build_page_links()

build_page_links(  $page_size,  $current_page,  $total,  $path,  $filter = false,  $sort = false)

Parameters

$page_size
$current_page
$total
$path
$filter
$sort

build_parent_mock()

build_parent_mock(  $request_type = 'HTML5')

Parameters

$request_type

bust_pop3_cache()

bust_pop3_cache(  $hm_cache,  $id)

Parameters

$hm_cache
$id

callback()

callback(  $v)

Parameters

$v

callback()

callback(  $val)

Parameters

$val

check_2fa_pin()

check_2fa_pin(  $pin,  $secret,  $pass_len = 6)

Parameters

$pin
$secret
$pass_len

check_php()

check_php(): void

Check PHP for correct support

check_php()

check_php()

check_recaptcha()

check_recaptcha(  $secret,  $response,  $ip)

Parameters

$secret
$response
$ip

checkbox_callback()

checkbox_callback(  $vals,  $style,  $output_mod)

Parameters

$vals
$style
$output_mod

clear_existing_reply_details()

clear_existing_reply_details(  $session)

Parameters

$session

combine_includes()

combine_includes(  $js,  $js_compress,  $css,  $css_compress,  $settings): void

Write out combined javascript and css files

Parameters

$js

string combined javascript from all modules

$js_compress

string command to compress the js

$css

string combined css from all modules

$css_compress

string command to compress the css

$settings

array site settings list

combined_sort_dialog()

combined_sort_dialog(  $mod)

Parameters

$mod

composerRequireac5d219e2f002e48ec04c730cdbc9f33()

composerRequireac5d219e2f002e48ec04c730cdbc9f33(  $fileIdentifier,  $file)

Parameters

$fileIdentifier
$file

compress()

compress(  $string,  $command,  $file = false): string

Compress a string

Parameters

$string

string content to compress

$command

string command to do the compression

$file

Returns

string —

compressed string

compress_methods()

compress_methods(  $settings): array

Check for site specific compression commands

Parameters

$settings

array site settings list

Returns

array —

compression methods or false for none

config_source()

config_source(  $selected = 'hm3.sample.ini')

Parameters

$selected

convert_html_to_text()

convert_html_to_text(  $html)

Parameters

$html

copy_recursive()

copy_recursive(string  $path): void

Recursively copy files

Parameters

string $path

file path with no trailing slash

create_production_site()

create_production_site(  $assets,  $settings,  $hashes): void

Copies the site.js and site.css files to the site/ directory, and creates a production version of the index.php file.

Parameters

$assets
$settings
$hashes

create_secret()

create_secret(  $key,  $user,  $len)

Parameters

$key
$user
$len

credentials_form()

credentials_form(  $details,  $mod)

Parameters

$details
$mod

crypt_state()

crypt_state(object  $config): boolean

Determine encryption for user settings

Parameters

object $config

site configuration

Returns

boolean

css_compress_setting()

css_compress_setting(  $current)

Parameters

$current

custom_themes()

custom_themes(  $config,  $themes)

Parameters

$config
$themes

cypht_login()

cypht_login(string  $user,string  $pass,string  $url,  $lifetime): boolean

Start a user session if the user/pass are valid

Parameters

string $user

username

string $pass

password

string $url

location of the Cypht installation

$lifetime

Returns

boolean

cypht_logout()

cypht_logout(): void

Log a user out of cypht

data_source_available()

data_source_available(  $mods,  $types)

Parameters

$mods
$types

date_callback()

date_callback(  $vals,  $style,  $output_mod)

Parameters

$vals
$style
$output_mod

dateInESTTZ()

dateInESTTZ()

db_driver_setting()

db_driver_setting(  $current)

Parameters

$current

db_host_setting()

db_host_setting(  $current)

Parameters

$current

db_name_setting()

db_name_setting(  $current)

Parameters

$current

db_pass_setting()

db_pass_setting(  $current)

Parameters

$current

db_user_setting()

db_user_setting(  $current)

Parameters

$current

decode_fld()

decode_fld(  $string)

Parameters

$string

decode_folder_str()

decode_folder_str(  $folder)

Parameters

$folder

default_language_setting()

default_language_setting(  $current)

Parameters

$current

default_smtp_name_setting()

default_smtp_name_setting(  $current)

Parameters

$current

default_smtp_port_setting()

default_smtp_port_setting(  $current)

Parameters

$current

default_smtp_server()

default_smtp_server(  $user_config,  $session,  $request,  $config,  $user,  $pass)

Parameters

$user_config
$session
$request
$config
$user
$pass

default_smtp_server_setting()

default_smtp_server_setting(  $current)

Parameters

$current

default_smtp_tls_setting()

default_smtp_tls_setting(  $current)

Parameters

$current

default_sort_order_callback()

default_sort_order_callback(  $val)

Parameters

$val

default_sort_order_opts()

default_sort_order_opts()

delete_disabled_callback()

delete_disabled_callback(  $val)

Parameters

$val

delete_draft()

delete_draft(  $id,  $session)

Parameters

$id
$session

delete_uploaded_files()

delete_uploaded_files(  $session,  $draft_id = false,  $filename = false)

Parameters

$session
$draft_id
$filename

delete_uploaded_files()

delete_uploaded_files(  $obj)

Parameters

$obj

disable_tls_setting()

disable_tls_setting(  $current)

Parameters

$current

display_value()

display_value(  $name,  $haystack,  $type = false,  $default = '')

Parameters

$name
$haystack
$type
$default

dynamic_login_config()

dynamic_login_config(  $config)

Parameters

$config

elog()

elog(mixed  $mixed): boolean|null

Easy to use error logging

Parameters

mixed $mixed

vaule to send to the log

Returns

boolean|null

email_is_active()

email_is_active(  $mod_list)

Parameters

$mod_list

enable_2fa_callback()

enable_2fa_callback(  $val)

Parameters

$val

encrypt_ajax_requests_setting()

encrypt_ajax_requests_setting(  $current)

Parameters

$current

encrypt_local_storage_setting()

encrypt_local_storage_setting(  $current)

Parameters

$current

feed_memcached_fetch()

feed_memcached_fetch(  $hmod,  $feed_data)

Parameters

$hmod
$feed_data

feed_memcached_save()

feed_memcached_save(  $hmod,  $feed_data,  $data)

Parameters

$hmod
$feed_data
$data

feed_source_callback()

feed_source_callback(  $vals,  $style,  $output_mod)

Parameters

$vals
$style
$output_mod

fetch_gmail_contacts()

fetch_gmail_contacts(  $config,  $contact_store,  $session = false)

Parameters

$config
$contact_store
$session

fetch_ldap_contacts()

fetch_ldap_contacts(  $config,  $user_config,  $contact_store,  $session = false)

Parameters

$config
$user_config
$contact_store
$session

filter_message_part()

filter_message_part(  $vals)

Parameters

$vals

filters()

filters()

find_imap_by_smtp()

find_imap_by_smtp(  $imap_profiles,  $smtp_profile)

Parameters

$imap_profiles
$smtp_profile

flatten()

flatten(  $str)

Parameters

$str

format_attached_image_section()

format_attached_image_section(  $struct,  $output_mod,  $dl_link)

Parameters

$struct
$output_mod
$dl_link

format_attachment_row()

format_attachment_row(  $file,  $output_mod)

Parameters

$file
$output_mod

format_data_sources()

format_data_sources(  $array,  $output_mod)

Parameters

$array
$output_mod

format_imap_envelope()

format_imap_envelope(  $env,  $mod)

Parameters

$env
$mod

format_imap_folder_section()

format_imap_folder_section(  $folders,  $id,  $output_mod)

Parameters

$folders
$id
$output_mod

format_imap_from_fld()

format_imap_from_fld(  $fld)

Parameters

$fld

format_imap_message_list()

format_imap_message_list(  $msg_list,  $output_module,  $parent_list = false,  $style = 'email')

Parameters

$msg_list
$output_module
$parent_list
$style

format_keyboard_action()

format_keyboard_action(  $action)

Parameters

$action

format_list_headers()

format_list_headers(  $mod)

Parameters

$mod

format_msg_html()

format_msg_html(  $str,  $images = false)

Parameters

$str
$images

format_msg_image()

format_msg_image(  $str,  $mime_type)

Parameters

$str
$mime_type

format_msg_part_row()

format_msg_part_row(  $id,  $vals,  $output_mod,  $level,  $part,  $dl_args,  $use_icons = false,  $simple_view = false,  $mobile = false)

Parameters

$id
$vals
$output_mod
$level
$part
$dl_args
$use_icons
$simple_view
$mobile

format_msg_part_section()

format_msg_part_section(  $struct,  $output_mod,  $part,  $dl_link,  $level)

Parameters

$struct
$output_mod
$part
$dl_link
$level

format_msg_text()

format_msg_text(  $str,  $output_mod,  $links = true)

Parameters

$str
$output_mod
$links

format_pop3_message_list()

format_pop3_message_list(  $msg_list,  $output_module,  $style,  $login_time,  $list_parent)

Parameters

$msg_list
$output_module
$style
$login_time
$list_parent

format_reply_address()

format_reply_address(  $fld,  $excluded)

Parameters

$fld
$excluded

format_reply_as_html()

format_reply_as_html(  $body,  $type,  $reply_type,  $lead_in)

Parameters

$body
$type
$reply_type
$lead_in

format_reply_as_text()

format_reply_as_text(  $body,  $type,  $reply_type,  $lead_in)

Parameters

$body
$type
$reply_type
$lead_in

format_reply_fields()

format_reply_fields(  $body,  $headers,  $struct,  $html,  $output_mod,  $type = 'reply')

Parameters

$body
$headers
$struct
$html
$output_mod
$type

format_reply_text()

format_reply_text(  $txt)

Parameters

$txt

format_shortcut_section()

format_shortcut_section(  $data,  $type,  $output_mod)

Parameters

$data
$type
$output_mod

format_shortcuts()

format_shortcuts(  $data)

Parameters

$data

generate_qr_code()

generate_qr_code(  $config,  $username,  $str)

Parameters

$config
$username
$str

get_2fa_key()

get_2fa_key(  $config)

Parameters

$config

get_auth_config()

get_auth_config(  $config,  $prefix)

Parameters

$config
$prefix

get_date_bounds()

get_date_bounds(  $data,  $view)

Parameters

$data
$view

get_draft()

get_draft(  $id,  $session)

Parameters

$id
$session

get_feed_ids()

get_feed_ids(  $sources)

Parameters

$sources

get_github_ids()

get_github_ids(  $sources,  $repos)

Parameters

$sources
$repos

get_imap_ids()

get_imap_ids(  $sources)

Parameters

$sources

get_imap_mime_extension()

get_imap_mime_extension(  $type,  $subtype)

Parameters

$type
$subtype

get_imap_part_name()

get_imap_part_name(  $struct,  $uid,  $part_id,  $no_default = false)

Parameters

$struct
$uid
$part_id
$no_default

get_imap_size()

get_imap_size(  $vals)

Parameters

$vals

get_ini()

get_ini(  $config,  $name,  $sections = false)

Parameters

$config
$name
$sections

get_ldap_value()

get_ldap_value(  $fld,  $mod)

Parameters

$fld
$mod

get_list_headers()

get_list_headers(  $headers)

Parameters

$headers

get_message_list_settings()

get_message_list_settings(  $path,  $handler)

Parameters

$path
$handler

get_module_assignments()

get_module_assignments(  $settings): array

Get module content and filters. This function has a side effect of setting up all the module assignments in Hm_Output_Modules and Hm_Handler_Modules.

(this happens when the module set's setup.php file is included). These will be recorded later in the write_config_file function

Parameters

$settings

array site settings list

Returns

array —

js and css blobs, combined filers array, and module assets

get_modules()

get_modules(array  $settings): array

get module list from settings

Parameters

array $settings

site settings list

Returns

array

get_oauth2_data()

get_oauth2_data(  $config)

Parameters

$config

get_outbound_msg_detail()

get_outbound_msg_detail(  $post,  $draft,  $body_type)

Parameters

$post
$draft
$body_type

get_outbound_msg_profile_detail()

get_outbound_msg_profile_detail(  $form,  $profiles,  $smtp_details,  $hmod)

Parameters

$form
$profiles
$smtp_details
$hmod

get_part_desc()

get_part_desc(  $vals,  $id,  $part)

Parameters

$vals
$id
$part

get_personal_ns()

get_personal_ns(  $imap)

Parameters

$imap

get_primary_recipient()

get_primary_recipient(  $profiles,  $headers,  $smtp_servers)

Parameters

$profiles
$headers
$smtp_servers

get_rule_ids()

get_rule_ids(  $sources,  $type,  $repos)

Parameters

$sources
$type
$repos

get_search_from_post()

get_search_from_post(  $request)

Parameters

$request

get_search_from_url()

get_search_from_url(  $request)

Parameters

$request

get_special_folders()

get_special_folders(  $mod,  $id)

Parameters

$mod
$id

get_tls_stream_type()

get_tls_stream_type()

get_uploaded_files()

get_uploaded_files(  $id,  $session)

Parameters

$id
$session

github_connect_details()

github_connect_details(  $config)

Parameters

$config

github_parse_headers()

github_parse_headers(  $data,  $output_mod)

Parameters

$data
$output_mod

github_parse_payload()

github_parse_payload(  $data,  $output_mod)

Parameters

$data
$output_mod

gmail_contacts_request()

gmail_contacts_request(  $token,  $url)

Parameters

$token
$url

group_data_sources()

group_data_sources(  $array)

Parameters

$array

handler_source()

handler_source(string  $source): void

Add a module set name to the input processing manager

Parameters

string $source

module set name

hide_folder_icons_callback()

hide_folder_icons_callback(  $val)

Parameters

$val

hl_base_rule()

hl_base_rule(  $form,  $type)

Parameters

$form
$type

hl_feeds_rule()

hl_feeds_rule(  $form)

Parameters

$form

hl_github_rule()

hl_github_rule(  $form,  $mod)

Parameters

$form
$mod

hl_imap_rule()

hl_imap_rule(  $form)

Parameters

$form

hm_exists()

hm_exists(string  $name): boolean

See if a function already exists

Parameters

string $name

function name to check

Returns

boolean

hm_get_module_from_path()

hm_get_module_from_path(string  $path): string

Return the module set name from a file path

Parameters

string $path

file path

Returns

string

hm_theme_icons()

hm_theme_icons(  $color = 'white')

Parameters

$color

hm_themes()

hm_themes()

HTMLPurifier()

HTMLPurifier(string  $html,mixed  $config = null): string

Purify HTML.

Parameters

string $html

String HTML to purify

mixed $config

Configuration to use, can be any value accepted by HTMLPurifier_Config::create()

Returns

string

htmlpurifier_filter_extractstyleblocks_muteerrorhandler()

htmlpurifier_filter_extractstyleblocks_muteerrorhandler()

human_readable_interval()

human_readable_interval(  $date_str)

Parameters

$date_str

icon_callback()

icon_callback(  $vals,  $style,  $output_mod)

Parameters

$vals
$style
$output_mod

icon_color()

icon_color(  $theme)

Parameters

$theme

imap_auth_name_setting()

imap_auth_name_setting(  $current)

Parameters

$current

imap_auth_port_setting()

imap_auth_port_setting(  $current)

Parameters

$current

imap_auth_server_setting()

imap_auth_server_setting(  $current)

Parameters

$current

imap_auth_tls_setting()

imap_auth_tls_setting(  $current)

Parameters

$current

imap_authed()

imap_authed(  $imap)

Parameters

$imap

imap_data_sources()

imap_data_sources(  $callback,  $custom = array())

Parameters

$callback
$custom

imap_move_different_server()

imap_move_different_server(  $ids,  $action,  $dest_path,  $hm_cache)

Parameters

$ids
$action
$dest_path
$hm_cache

imap_move_same_server()

imap_move_same_server(  $ids,  $action,  $hm_cache,  $dest_path)

Parameters

$ids
$action
$hm_cache
$dest_path

imap_refresh_oauth2_token()

imap_refresh_oauth2_token(  $server,  $config)

Parameters

$server
$config

imap_sent_sources()

imap_sent_sources(  $callback,  $mod)

Parameters

$callback
$mod

imap_server_type()

imap_server_type(  $id)

Parameters

$id

in_server_list()

in_server_list(  $list,  $id,  $user)

Parameters

$list
$id
$user

inline_message_callback()

inline_message_callback(  $val)

Parameters

$val

inline_message_style_callback()

inline_message_style_callback(  $val)

Parameters

$val

interface_langs()

interface_langs()

is_email_address()

is_email_address(  $val,  $allow_local = false)

Parameters

$val
$allow_local

is_news_feed()

is_news_feed(  $url,  $limit = 20)

Parameters

$url
$limit

js_compress_setting()

js_compress_setting(  $current)

Parameters

$current

keycodes()

keycodes()

kses()

kses(  $string,  $allowed_html,  $allowed_protocols = null)

Parameters

$string
$allowed_html
$allowed_protocols

language_setting_callback()

language_setting_callback(  $val)

Parameters

$val

lc_headers()

lc_headers(  $headers)

Parameters

$headers

ldap_add_user_auth()

ldap_add_user_auth(  $ldap_config,  $auths)

Parameters

$ldap_config
$auths

ldap_config()

ldap_config(  $config,  $key = false)

Parameters

$config
$key

list_controls()

list_controls(  $refresh_link,  $config_link,  $source_link = false)

Parameters

$refresh_link
$config_link
$source_link

list_sources()

list_sources(  $sources,  $output_mod)

Parameters

$sources
$output_mod

list_style_callback()

list_style_callback(  $val)

Parameters

$val

load_user_config_object()

load_user_config_object(object  $config): object

Load a user config object

Parameters

object $config

site configuration

Returns

object

mailto_handler_callback()

mailto_handler_callback(  $val)

Parameters

$val

max_source_setting_callback()

max_source_setting_callback(  $val)

Parameters

$val

merge_folder_list_details()

merge_folder_list_details(  $folder_sources)

Parameters

$folder_sources

merge_imap_search_results()

merge_imap_search_results(  $ids,  $search_type,  $session,  $hm_cache,  $folders = array('INBOX'),  $limit,  $terms = array(),  $sent = false)

Parameters

$ids
$search_type
$session
$hm_cache
$folders
$limit
$terms
$sent

message_controls()

message_controls(  $output_mod)

Parameters

$output_mod

message_list_meta()

message_list_meta(  $input,  $output_mod)

Parameters

$input
$output_mod

message_list_row()

message_list_row(  $values,  $id,  $style,  $output_mod,  $row_class = '')

Parameters

$values
$id
$style
$output_mod
$row_class

message_since_dropdown()

message_since_dropdown(  $since,  $name,  $output_mod)

Parameters

$since
$name
$output_mod

module_init_functions()

module_init_functions(object  $user_config,object  $session,object  $request,object  $config,string  $user,string  $pass): void

Run functions assigned to the "page" functional_api

Parameters

object $user_config

user configuration object

object $session

user session object

object $request

page request object

object $config

site configuration object

string $user

username

string $pass

password

msg_part_icons_callback()

msg_part_icons_callback(  $val)

Parameters

$val

name_map()

name_map(  $val)

Parameters

$val

next_draft_key()

next_draft_key(  $session)

Parameters

$session

no_password_callback()

no_password_callback(  $val)

Parameters

$val

oauth2_form()

oauth2_form(  $details,  $mod)

Parameters

$details
$mod

out()

out(  $str)

Parameters

$str

outbound_address_check()

outbound_address_check(  $mod,  $from,  $reply_to)

Parameters

$mod
$from
$reply_to

output_modules()

output_modules(  $settings)

Parameters

$settings

output_page()

output_page(  $source)

Parameters

$source

output_settings()

output_settings(  $settings)

Parameters

$settings

output_source()

output_source(string  $source): void

Add a module set name to the output module manager

Parameters

string $source

module set name

page_style()

page_style()

parse_contact_xml()

parse_contact_xml(  $xml,  $source)

Parameters

$xml
$source

parse_mailto()

parse_mailto(  $str)

Parameters

$str

parse_module_ini_files()

parse_module_ini_files(  $settings)

include module ini files in the main config

Parameters

$settings

payload_search()

payload_search(  $data)

Parameters

$data

pop3_auth_name_setting()

pop3_auth_name_setting(  $current)

Parameters

$current

pop3_auth_port_setting()

pop3_auth_port_setting(  $current)

Parameters

$current

pop3_auth_server_setting()

pop3_auth_server_setting(  $current)

Parameters

$current

pop3_auth_tls_setting()

pop3_auth_tls_setting(  $current)

Parameters

$current

pop3_authed()

pop3_authed(  $pop3)

Parameters

$pop3

prep_folder_name()

prep_folder_name(  $imap,  $folder,  $decode_folder = false,  $parent = false)

Parameters

$imap
$folder
$decode_folder
$parent

prepare_imap_message_list()

prepare_imap_message_list(  $msgs,  $mod,  $type)

Parameters

$msgs
$mod
$type

process_address_fld()

process_address_fld(  $fld)

Parameters

$fld

process_imap_message_ids()

process_imap_message_ids(  $ids)

Parameters

$ids

process_list_fld()

process_list_fld(  $fld)

Parameters

$fld

process_move_to_arguments()

process_move_to_arguments(  $form)

Parameters

$form

process_since_argument()

process_since_argument(  $val,  $validate = false)

Parameters

$val
$validate

process_site_setting()

process_site_setting(  $type,  $handler,  $callback = false,  $default = false,  $checkbox = false)

Parameters

$type
$handler
$callback
$default
$checkbox

process_sort_arg()

process_sort_arg(  $sort,  $default = 'arrival')

Parameters

$sort
$default

profile_form()

profile_form(  $form_vals,  $id,  $smtp_servers,  $imap_servers,  $out_mod)

Parameters

$form_vals
$id
$smtp_servers
$imap_servers
$out_mod

profile_from_compose_smtp_id()

profile_from_compose_smtp_id(  $profiles,  $id)

Parameters

$profiles
$id

profiles_by_smtp_id()

profiles_by_smtp_id(  $profiles,  $id)

Parameters

$profiles
$id

prompt_for_passhrase()

prompt_for_passhrase(  $mod)

Parameters

$mod

random_bytes()

random_bytes(integer  $bytes): string

Windows with PHP < 5.3.0 will not have the function openssl_random_pseudo_bytes() available, so let's use CAPICOM to work around this deficiency.

Parameters

integer $bytes

Throws

\Exception

Returns

string

random_bytes()

random_bytes(integer  $bytes): string

Unless open_basedir is enabled, use /dev/urandom for random numbers in accordance with best practices

Why we use /dev/urandom and not /dev/random

Parameters

integer $bytes

Throws

\Exception

Returns

string

random_bytes()

random_bytes(integer  $bytes): string

If the libsodium PHP extension is loaded, we'll use it above any other solution.

libsodium-php project:

Parameters

integer $bytes

Throws

\Exception

Returns

string

random_bytes()

random_bytes(integer  $bytes): string

If the libsodium PHP extension is loaded, we'll use it above any other solution.

libsodium-php project:

Parameters

integer $bytes

Throws

\Exception

Returns

string

random_bytes()

random_bytes(mixed  $length): string

We don't have any more options, so let's throw an exception right now and hope the developer won't let it fail silently.

Parameters

mixed $length

Throws

\Exception

Returns

string

random_bytes()

random_bytes(integer  $bytes): string

Powered by ext/mcrypt (and thankfully NOT libmcrypt)

Parameters

integer $bytes

Throws

\Exception

Returns

string

random_int()

random_int(integer  $min,integer  $max): integer

Fetch a random integer between $min and $max inclusive

Parameters

integer $min
integer $max

Throws

\Exception

Returns

integer

RandomCompat_intval()

RandomCompat_intval(integer|float  $number,boolean  $fail_open = false): float|integer

Cast to an integer if we can, safely.

If you pass it a float in the range (~PHP_INT_MAX, PHP_INT_MAX) (non-inclusive), it will sanely cast it to an int. If you it's equal to ~PHP_INT_MAX or PHP_INT_MAX, we let it fail as not an integer. Floats lose precision, so the <= and => operators might accidentally let a float through.

Parameters

integer|float $number

The number we want to convert to an int

boolean $fail_open

Set to true to not throw an exception

Throws

\TypeError

Returns

float|integer

RandomCompat_strlen()

RandomCompat_strlen(string  $binary_string): integer

strlen() implementation that isn't brittle to mbstring.func_overload

This version just used the default strlen()

Parameters

string $binary_string

Throws

\TypeError

Returns

integer

RandomCompat_substr()

RandomCompat_substr(string  $binary_string,integer  $start,integer|null  $length = null): string

substr() implementation that isn't brittle to mbstring.func_overload

This version just uses the default substr()

Parameters

string $binary_string
integer $start
integer|null $length

(optional)

Throws

\TypeError

Returns

string

read_config()

read_config(  $source)

Parameters

$source

recaptcha_config()

recaptcha_config(  $config)

Parameters

$config

replace_module()

replace_module(string  $type,string  $target,string  $replacement,string  $page = false)

Replace an already assigned module with a different one

Parameters

string $type

either output or handler

string $target

module name to replace

string $replacement

module to swap in

string $page

request id, otherwise try all page names $return void

reply_format_body()

reply_format_body(  $headers,  $body,  $lead_in,  $reply_type,  $struct,  $html)

Parameters

$headers
$body
$lead_in
$reply_type
$struct
$html

reply_lead_in()

reply_lead_in(  $headers,  $type,  $to,  $output_mod)

Parameters

$headers
$type
$to
$output_mod

reply_to_address()

reply_to_address(  $headers,  $type)

Parameters

$headers
$type

reply_to_id()

reply_to_id(  $headers,  $type)

Parameters

$headers
$type

reply_to_subject()

reply_to_subject(  $headers,  $type)

Parameters

$headers
$type

repopulate_compose_form()

repopulate_compose_form(  $draft,  $handler_mod)

Parameters

$draft
$handler_mod

safe_output_callback()

safe_output_callback(  $vals,  $style,  $output_mod)

Parameters

$vals
$style
$output_mod

save_draft()

save_draft(  $atts,  $id,  $session)

Parameters

$atts
$id
$session

save_imap_draft()

save_imap_draft(  $atts,  $id,  $session,  $mod,  $mod_cache)

Parameters

$atts
$id
$session
$mod
$mod_cache

save_uploaded_file()

save_uploaded_file(  $id,  $atts,  $session)

Parameters

$id
$atts
$session

save_user_settings()

save_user_settings(  $handler,  $form,  $logout)

Parameters

$handler
$form
$logout

search_feed_item()

search_feed_item(  $item,  $terms,  $since,  $fld)

Parameters

$item
$terms
$since
$fld

search_field_selection()

search_field_selection(  $current,  $output_mod)

Parameters

$current
$output_mod

search_for_feeds()

search_for_feeds(  $html)

Parameters

$html

search_pop3_msg()

search_pop3_msg(  $body,  $headers,  $terms,  $fld)

Parameters

$body
$headers
$terms
$fld

select_box()

select_box(  $name,  $selected,  $opts)

Parameters

$name
$selected
$opts

server_from_compose_smtp_id()

server_from_compose_smtp_id(  $id)

Parameters

$id

session_init()

session_init(): array

Startup the session and request objects

Returns

array

session_type_setting()

session_type_setting(  $selected = false)

Parameters

$selected

setting_defaults()

setting_defaults()

setup_base_ajax_page()

setup_base_ajax_page(  $name,  $source = false)

Parameters

$name
$source

setup_base_page()

setup_base_page(  $name,  $source = false)

Parameters

$name
$source

setup_db()

setup_db(  $config)

Parameters

$config

shortcut_defaults()

shortcut_defaults(  $user_config = false)

Parameters

$user_config

shortcut_enabled_callback()

shortcut_enabled_callback(  $val)

Parameters

$val

show_list_icons_callback()

show_list_icons_callback(  $val)

Parameters

$val

simple_msg_view_callback()

simple_msg_view_callback(  $val)

Parameters

$val

since_setting_callback()

since_setting_callback(  $val)

Parameters

$val

smtp_authed()

smtp_authed(  $smtp)

Parameters

$smtp

smtp_auto_bcc_callback()

smtp_auto_bcc_callback(  $val)

Parameters

$val

smtp_compose_type_callback()

smtp_compose_type_callback(  $val)

Parameters

$val

smtp_refresh_oauth2_token()

smtp_refresh_oauth2_token(  $server,  $config)

Parameters

$server
$config

smtp_refresh_oauth2_token_on_send()

smtp_refresh_oauth2_token_on_send(  $smtp_details,  $mod,  $smtp_id)

Parameters

$smtp_details
$mod
$smtp_id

smtp_server_dropdown()

smtp_server_dropdown(  $data,  $output_mod,  $recip,  $selected_id = false)

Parameters

$data
$output_mod
$recip
$selected_id

sort_by_internal_date()

sort_by_internal_date(  $a,  $b)

Parameters

$a
$b

start_page_callback()

start_page_callback(  $val)

Parameters

$val

start_page_opts()

start_page_opts()

subject_callback()

subject_callback(  $vals,  $style,  $output_mod)

Parameters

$vals
$style
$output_mod

text_only_callback()

text_only_callback(  $val)

Parameters

$val

timezone_setting_callback()

timezone_setting_callback(  $val)

Parameters