diff --git a/source/administrator-guide/roundcube-settings/activesync_debug.txt b/source/administrator-guide/roundcube-settings/activesync_debug.txt --- a/source/administrator-guide/roundcube-settings/activesync_debug.txt +++ b/source/administrator-guide/roundcube-settings/activesync_debug.txt @@ -3,6 +3,4 @@ ``activesync_debug`` -------------------- -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Enables ActiveSync protocol debuging. diff --git a/source/administrator-guide/roundcube-settings/activesync_user_log.txt b/source/administrator-guide/roundcube-settings/activesync_user_log.txt --- a/source/administrator-guide/roundcube-settings/activesync_user_log.txt +++ b/source/administrator-guide/roundcube-settings/activesync_user_log.txt @@ -3,6 +3,4 @@ ``activesync_user_log`` ----------------------- -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Enables logging to a separate directory for every user/device. diff --git a/source/administrator-guide/roundcube-settings/address_book_type.txt b/source/administrator-guide/roundcube-settings/address_book_type.txt --- a/source/administrator-guide/roundcube-settings/address_book_type.txt +++ b/source/administrator-guide/roundcube-settings/address_book_type.txt @@ -3,6 +3,11 @@ ``address_book_type`` ===================== -.. include:: roundcube-settings/needs-work.txt +This indicates which type of address book to use. Possible choises: +'sql' (default), 'ldap' and ''. -Sadly, this setting has not yet been documented. +If set to 'ldap' then it will look at using the first writable LDAP +address book as the primary address book and it will not display the +SQL address book in the 'Address Book' view. +If set to '' then no address book will be displayed or only the +addressbook which is created by a plugin (like CardDAV). diff --git a/source/administrator-guide/roundcube-settings/address_template.txt b/source/administrator-guide/roundcube-settings/address_template.txt --- a/source/administrator-guide/roundcube-settings/address_template.txt +++ b/source/administrator-guide/roundcube-settings/address_template.txt @@ -3,6 +3,5 @@ ``address_template`` ==================== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Show address fields in this order. +Available placeholders: {street}, {locality}, {zipcode}, {country}, {region} diff --git a/source/administrator-guide/roundcube-settings/addressbook_name_listing.txt b/source/administrator-guide/roundcube-settings/addressbook_name_listing.txt --- a/source/administrator-guide/roundcube-settings/addressbook_name_listing.txt +++ b/source/administrator-guide/roundcube-settings/addressbook_name_listing.txt @@ -3,6 +3,8 @@ ``addressbook_name_listing`` ============================ -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +the way how contact names are displayed in the list +- 0: display name +- 1: (prefix) firstname middlename surname (suffix) +- 2: (prefix) surname firstname middlename (suffix) +- 3: (prefix) surname, firstname middlename (suffix) diff --git a/source/administrator-guide/roundcube-settings/addressbook_pagesize.txt b/source/administrator-guide/roundcube-settings/addressbook_pagesize.txt --- a/source/administrator-guide/roundcube-settings/addressbook_pagesize.txt +++ b/source/administrator-guide/roundcube-settings/addressbook_pagesize.txt @@ -3,6 +3,4 @@ ``addressbook_pagesize`` ======================== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Show up to X items in contacts list view. diff --git a/source/administrator-guide/roundcube-settings/addressbook_search_mode.txt b/source/administrator-guide/roundcube-settings/addressbook_search_mode.txt --- a/source/administrator-guide/roundcube-settings/addressbook_search_mode.txt +++ b/source/administrator-guide/roundcube-settings/addressbook_search_mode.txt @@ -3,6 +3,10 @@ ``addressbook_search_mode`` =========================== -.. include:: roundcube-settings/needs-work.txt +Matching mode for addressbook search (including autocompletion) -Sadly, this setting has not yet been documented. +- 0 - partial (*abc*), default +- 1 - strict (abc) +- 2 - prefix (abc*) + +Note: For LDAP sources fuzzy_search must be enabled to use 'partial' or 'prefix' mode. diff --git a/source/administrator-guide/roundcube-settings/addressbook_search_mods.txt b/source/administrator-guide/roundcube-settings/addressbook_search_mods.txt --- a/source/administrator-guide/roundcube-settings/addressbook_search_mods.txt +++ b/source/administrator-guide/roundcube-settings/addressbook_search_mods.txt @@ -3,6 +3,5 @@ ``addressbook_search_mods`` =========================== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Defaults of the addressbook search field configuration. +Example: array('name'=>1, 'firstname'=>1, 'surname'=>1, 'email'=>1, '*'=>1); diff --git a/source/administrator-guide/roundcube-settings/addressbook_sort_col.txt b/source/administrator-guide/roundcube-settings/addressbook_sort_col.txt --- a/source/administrator-guide/roundcube-settings/addressbook_sort_col.txt +++ b/source/administrator-guide/roundcube-settings/addressbook_sort_col.txt @@ -3,6 +3,4 @@ ``addressbook_sort_col`` ======================== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Sort contacts by this column (preferably either one of name, firstname, surname) diff --git a/source/administrator-guide/roundcube-settings/advanced_prefs.txt b/source/administrator-guide/roundcube-settings/advanced_prefs.txt --- a/source/administrator-guide/roundcube-settings/advanced_prefs.txt +++ b/source/administrator-guide/roundcube-settings/advanced_prefs.txt @@ -3,6 +3,4 @@ ``advanced_prefs`` ================== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Define which settings should be listed under the 'advanced' block which is hidden by default diff --git a/source/administrator-guide/roundcube-settings/auto_create_user.txt b/source/administrator-guide/roundcube-settings/auto_create_user.txt --- a/source/administrator-guide/roundcube-settings/auto_create_user.txt +++ b/source/administrator-guide/roundcube-settings/auto_create_user.txt @@ -3,6 +3,6 @@ ``auto_create_user`` ==================== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Automatically create a new Roundcube user when log-in the first time. +A new user will be created once the IMAP login succeeds. +Set to false if only registered users can use this service diff --git a/source/administrator-guide/roundcube-settings/autocomplete_max.txt b/source/administrator-guide/roundcube-settings/autocomplete_max.txt --- a/source/administrator-guide/roundcube-settings/autocomplete_max.txt +++ b/source/administrator-guide/roundcube-settings/autocomplete_max.txt @@ -3,6 +3,4 @@ ``autocomplete_max`` ==================== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Max. numer of entries in autocomplete popup. Default: 15. diff --git a/source/administrator-guide/roundcube-settings/autocomplete_min_length.txt b/source/administrator-guide/roundcube-settings/autocomplete_min_length.txt --- a/source/administrator-guide/roundcube-settings/autocomplete_min_length.txt +++ b/source/administrator-guide/roundcube-settings/autocomplete_min_length.txt @@ -3,6 +3,4 @@ ``autocomplete_min_length`` =========================== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +The minimum number of characters required to be typed in an autocomplete field before address books will be searched. Most useful for LDAP directories that may need to do lengthy results building given overly-broad searches diff --git a/source/administrator-guide/roundcube-settings/autocomplete_single.txt b/source/administrator-guide/roundcube-settings/autocomplete_single.txt --- a/source/administrator-guide/roundcube-settings/autocomplete_single.txt +++ b/source/administrator-guide/roundcube-settings/autocomplete_single.txt @@ -3,6 +3,5 @@ ``autocomplete_single`` ======================= -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Default font for composed HTML message. +Supported values: Andale Mono, Arial, Arial Black, Book Antiqua, Courier New, Georgia, Helvetica, Impact, Tahoma, Terminal, Times New Roman, Trebuchet MS, Verdana diff --git a/source/administrator-guide/roundcube-settings/autocomplete_threads.txt b/source/administrator-guide/roundcube-settings/autocomplete_threads.txt --- a/source/administrator-guide/roundcube-settings/autocomplete_threads.txt +++ b/source/administrator-guide/roundcube-settings/autocomplete_threads.txt @@ -3,6 +3,5 @@ ``autocomplete_threads`` ======================== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Number of parallel autocomplete requests. +If there's more than one address book, n parallel (async) requests will be created, where each request will search in one address book. By default (0), all address books are searched in one request. diff --git a/source/administrator-guide/roundcube-settings/autoexpand_threads.txt b/source/administrator-guide/roundcube-settings/autoexpand_threads.txt --- a/source/administrator-guide/roundcube-settings/autoexpand_threads.txt +++ b/source/administrator-guide/roundcube-settings/autoexpand_threads.txt @@ -3,6 +3,6 @@ ``autoexpand_threads`` ====================== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +0 - Do not expand threads +1 - Expand all threads automatically +2 - Expand only threads with unread messages diff --git a/source/administrator-guide/roundcube-settings/check_all_folders.txt b/source/administrator-guide/roundcube-settings/check_all_folders.txt --- a/source/administrator-guide/roundcube-settings/check_all_folders.txt +++ b/source/administrator-guide/roundcube-settings/check_all_folders.txt @@ -3,6 +3,4 @@ ``check_all_folders`` ===================== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +If true all folders will be checked for recent messages. diff --git a/source/administrator-guide/roundcube-settings/client_mimetypes.txt b/source/administrator-guide/roundcube-settings/client_mimetypes.txt --- a/source/administrator-guide/roundcube-settings/client_mimetypes.txt +++ b/source/administrator-guide/roundcube-settings/client_mimetypes.txt @@ -3,6 +3,5 @@ ``client_mimetypes`` ==================== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Mimetypes supported by the browser. +Attachments of these types will open in a preview window either a comma-separated list or an array: 'text/plain,text/html,text/xml,image/jpeg,image/gif,image/png,application/pdf' diff --git a/source/administrator-guide/roundcube-settings/compose_extwin.txt b/source/administrator-guide/roundcube-settings/compose_extwin.txt --- a/source/administrator-guide/roundcube-settings/compose_extwin.txt +++ b/source/administrator-guide/roundcube-settings/compose_extwin.txt @@ -3,6 +3,4 @@ ``compose_extwin`` ================== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Open message compose form in new window diff --git a/source/administrator-guide/roundcube-settings/compose_responses_static.txt b/source/administrator-guide/roundcube-settings/compose_responses_static.txt --- a/source/administrator-guide/roundcube-settings/compose_responses_static.txt +++ b/source/administrator-guide/roundcube-settings/compose_responses_static.txt @@ -3,6 +3,4 @@ ``compose_responses_static`` ============================ -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +A static list of canned responses which are immutable for the user diff --git a/source/administrator-guide/roundcube-settings/contact_photo_size.txt b/source/administrator-guide/roundcube-settings/contact_photo_size.txt --- a/source/administrator-guide/roundcube-settings/contact_photo_size.txt +++ b/source/administrator-guide/roundcube-settings/contact_photo_size.txt @@ -3,6 +3,4 @@ ``contact_photo_size`` ====================== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Maximum size of uploaded contact photos in pixels. diff --git a/source/administrator-guide/roundcube-settings/date_format.txt b/source/administrator-guide/roundcube-settings/date_format.txt --- a/source/administrator-guide/roundcube-settings/date_format.txt +++ b/source/administrator-guide/roundcube-settings/date_format.txt @@ -3,6 +3,4 @@ ``date_format`` =============== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Use this format for date display (date or strftime format). diff --git a/source/administrator-guide/roundcube-settings/date_formats.txt b/source/administrator-guide/roundcube-settings/date_formats.txt --- a/source/administrator-guide/roundcube-settings/date_formats.txt +++ b/source/administrator-guide/roundcube-settings/date_formats.txt @@ -3,6 +3,5 @@ ``date_formats`` ================ -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Give this choice of date formats to the user to select from +Note: do not use ambiguous formats like m/d/Y diff --git a/source/administrator-guide/roundcube-settings/date_long.txt b/source/administrator-guide/roundcube-settings/date_long.txt --- a/source/administrator-guide/roundcube-settings/date_long.txt +++ b/source/administrator-guide/roundcube-settings/date_long.txt @@ -3,6 +3,4 @@ ``date_long`` ============= -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Use this format for detailed date/time formatting (derived from date_format and time_format). diff --git a/source/administrator-guide/roundcube-settings/date_short.txt b/source/administrator-guide/roundcube-settings/date_short.txt --- a/source/administrator-guide/roundcube-settings/date_short.txt +++ b/source/administrator-guide/roundcube-settings/date_short.txt @@ -3,6 +3,4 @@ ``date_short`` ============== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Use this format for detailed date/time formatting (derived from date_format and time_format). diff --git a/source/administrator-guide/roundcube-settings/debug_level.txt b/source/administrator-guide/roundcube-settings/debug_level.txt --- a/source/administrator-guide/roundcube-settings/debug_level.txt +++ b/source/administrator-guide/roundcube-settings/debug_level.txt @@ -3,6 +3,4 @@ ``debug_level`` =============== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +System error reporting, sum of: 1 = log; 4 = show diff --git a/source/administrator-guide/roundcube-settings/default_addressbook.txt b/source/administrator-guide/roundcube-settings/default_addressbook.txt --- a/source/administrator-guide/roundcube-settings/default_addressbook.txt +++ b/source/administrator-guide/roundcube-settings/default_addressbook.txt @@ -3,6 +3,6 @@ ``default_addressbook`` ======================= -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Defines address book (internal index) to which new contacts will be added. +By default it is the first writeable addressbook. +Note: Use '0' for built-in address book. diff --git a/source/administrator-guide/roundcube-settings/default_charset.txt b/source/administrator-guide/roundcube-settings/default_charset.txt --- a/source/administrator-guide/roundcube-settings/default_charset.txt +++ b/source/administrator-guide/roundcube-settings/default_charset.txt @@ -3,6 +3,4 @@ ``default_charset`` =================== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Use this charset as fallback for message decoding. diff --git a/source/administrator-guide/roundcube-settings/default_folders.txt b/source/administrator-guide/roundcube-settings/default_folders.txt --- a/source/administrator-guide/roundcube-settings/default_folders.txt +++ b/source/administrator-guide/roundcube-settings/default_folders.txt @@ -3,9 +3,7 @@ ``default_folders`` =================== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +This setting is obsolete and should not be used. .. seealso:: diff --git a/source/administrator-guide/roundcube-settings/default_font.txt b/source/administrator-guide/roundcube-settings/default_font.txt --- a/source/administrator-guide/roundcube-settings/default_font.txt +++ b/source/administrator-guide/roundcube-settings/default_font.txt @@ -3,6 +3,5 @@ ``default_font`` ================ -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Default font for composed HTML message. +Supported values: Andale Mono, Arial, Arial Black, Book Antiqua, Courier New, Georgia, Helvetica, Impact, Tahoma, Terminal, Times New Roman, Trebuchet MS, Verdana. diff --git a/source/administrator-guide/roundcube-settings/default_font_size.txt b/source/administrator-guide/roundcube-settings/default_font_size.txt --- a/source/administrator-guide/roundcube-settings/default_font_size.txt +++ b/source/administrator-guide/roundcube-settings/default_font_size.txt @@ -3,6 +3,5 @@ ``default_font_size`` ===================== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Default font size for composed HTML message. +Supported sizes: 8pt, 10pt, 12pt, 14pt, 18pt, 24pt, 36pt. diff --git a/source/administrator-guide/roundcube-settings/default_port.txt b/source/administrator-guide/roundcube-settings/default_port.txt --- a/source/administrator-guide/roundcube-settings/default_port.txt +++ b/source/administrator-guide/roundcube-settings/default_port.txt @@ -3,6 +3,4 @@ ``default_port`` ================ -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +TCP port used for IMAP connections diff --git a/source/administrator-guide/roundcube-settings/des_key.txt b/source/administrator-guide/roundcube-settings/des_key.txt --- a/source/administrator-guide/roundcube-settings/des_key.txt +++ b/source/administrator-guide/roundcube-settings/des_key.txt @@ -3,6 +3,4 @@ ``des_key`` =========== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +This key is used for encrypting purposes, like storing of imap password in the session. For historical reasons it's called DES_key, but it's used with any configured cipher_method (see below). diff --git a/source/administrator-guide/roundcube-settings/display_next.txt b/source/administrator-guide/roundcube-settings/display_next.txt --- a/source/administrator-guide/roundcube-settings/display_next.txt +++ b/source/administrator-guide/roundcube-settings/display_next.txt @@ -3,6 +3,4 @@ ``display_next`` ================ -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +If true, after message delete/move, the next message will be displayed. diff --git a/source/administrator-guide/roundcube-settings/display_version.txt b/source/administrator-guide/roundcube-settings/display_version.txt --- a/source/administrator-guide/roundcube-settings/display_version.txt +++ b/source/administrator-guide/roundcube-settings/display_version.txt @@ -3,6 +3,4 @@ ``display_version`` =================== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Display software version on login screen. diff --git a/source/administrator-guide/roundcube-settings/dont_override.txt b/source/administrator-guide/roundcube-settings/dont_override.txt --- a/source/administrator-guide/roundcube-settings/dont_override.txt +++ b/source/administrator-guide/roundcube-settings/dont_override.txt @@ -3,6 +3,4 @@ ``dont_override`` ================= -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Don't allow these settings to be overriden by the user. diff --git a/source/administrator-guide/roundcube-settings/draft_autosave.txt b/source/administrator-guide/roundcube-settings/draft_autosave.txt --- a/source/administrator-guide/roundcube-settings/draft_autosave.txt +++ b/source/administrator-guide/roundcube-settings/draft_autosave.txt @@ -3,6 +3,4 @@ ``draft_autosave`` ================== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Save compose message every 300 seconds (5min) diff --git a/source/administrator-guide/roundcube-settings/drafts_mbox.txt b/source/administrator-guide/roundcube-settings/drafts_mbox.txt --- a/source/administrator-guide/roundcube-settings/drafts_mbox.txt +++ b/source/administrator-guide/roundcube-settings/drafts_mbox.txt @@ -3,6 +3,6 @@ ``drafts_mbox`` =============== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Store draft message is this mailbox. +Leave blank if draft messages should not be stored. +NOTE: Use folder names with namespace prefix (INBOX. on Courier-IMAP) diff --git a/source/administrator-guide/roundcube-settings/dsn_default.txt b/source/administrator-guide/roundcube-settings/dsn_default.txt --- a/source/administrator-guide/roundcube-settings/dsn_default.txt +++ b/source/administrator-guide/roundcube-settings/dsn_default.txt @@ -3,6 +3,5 @@ ``dsn_default`` =============== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Delivery Status Notification checkbox default state. +Note: This can be used only if smtp_server is non-empty. diff --git a/source/administrator-guide/roundcube-settings/email_dns_check.txt b/source/administrator-guide/roundcube-settings/email_dns_check.txt --- a/source/administrator-guide/roundcube-settings/email_dns_check.txt +++ b/source/administrator-guide/roundcube-settings/email_dns_check.txt @@ -3,6 +3,4 @@ ``email_dns_check`` =================== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Enable DNS checking for e-mail address validation. diff --git a/source/administrator-guide/roundcube-settings/enable_installer.txt b/source/administrator-guide/roundcube-settings/enable_installer.txt --- a/source/administrator-guide/roundcube-settings/enable_installer.txt +++ b/source/administrator-guide/roundcube-settings/enable_installer.txt @@ -3,6 +3,5 @@ ``enable_installer`` ==================== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +THIS OPTION WILL ALLOW THE INSTALLER TO RUN AND CAN EXPOSE SENSITIVE CONFIG DATA. +ONLY ENABLE IT IF YOU'RE REALLY SURE WHAT YOU'RE DOING! diff --git a/source/administrator-guide/roundcube-settings/enable_spellcheck.txt b/source/administrator-guide/roundcube-settings/enable_spellcheck.txt --- a/source/administrator-guide/roundcube-settings/enable_spellcheck.txt +++ b/source/administrator-guide/roundcube-settings/enable_spellcheck.txt @@ -3,6 +3,4 @@ ``enable_spellcheck`` ===================== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Make use of the built-in spell checker. It is based on GoogieSpell. diff --git a/source/administrator-guide/roundcube-settings/force_7bit.txt b/source/administrator-guide/roundcube-settings/force_7bit.txt --- a/source/administrator-guide/roundcube-settings/force_7bit.txt +++ b/source/administrator-guide/roundcube-settings/force_7bit.txt @@ -3,6 +3,4 @@ ``force_7bit`` ============== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Use MIME encoding (quoted-printable) for 8bit characters in message body. diff --git a/source/administrator-guide/roundcube-settings/force_https.txt b/source/administrator-guide/roundcube-settings/force_https.txt --- a/source/administrator-guide/roundcube-settings/force_https.txt +++ b/source/administrator-guide/roundcube-settings/force_https.txt @@ -3,6 +3,6 @@ ``force_https`` =============== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Enforce connections over https. +With this option enabled, all non-secure connections will be redirected. +Set the port for the ssl connection as value of this option if it differs from the default 443. diff --git a/source/administrator-guide/roundcube-settings/forward_attachment.txt b/source/administrator-guide/roundcube-settings/forward_attachment.txt --- a/source/administrator-guide/roundcube-settings/forward_attachment.txt +++ b/source/administrator-guide/roundcube-settings/forward_attachment.txt @@ -3,6 +3,4 @@ ``forward_attachment`` ====================== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Sets default mode of Forward feature to "forward as attachment" diff --git a/source/administrator-guide/roundcube-settings/generic_message_footer.txt b/source/administrator-guide/roundcube-settings/generic_message_footer.txt --- a/source/administrator-guide/roundcube-settings/generic_message_footer.txt +++ b/source/administrator-guide/roundcube-settings/generic_message_footer.txt @@ -3,6 +3,5 @@ ``generic_message_footer`` ========================== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Path to a text file which will be added to each sent message. +Path is relative to the Roundcube root folder. diff --git a/source/administrator-guide/roundcube-settings/generic_message_footer_html.txt b/source/administrator-guide/roundcube-settings/generic_message_footer_html.txt --- a/source/administrator-guide/roundcube-settings/generic_message_footer_html.txt +++ b/source/administrator-guide/roundcube-settings/generic_message_footer_html.txt @@ -3,6 +3,5 @@ ``generic_message_footer_html`` =============================== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Path to a text file which will be added to each sent HTML message. +Paths are relative to the Roundcube root folder. diff --git a/source/administrator-guide/roundcube-settings/htmleditor.txt b/source/administrator-guide/roundcube-settings/htmleditor.txt --- a/source/administrator-guide/roundcube-settings/htmleditor.txt +++ b/source/administrator-guide/roundcube-settings/htmleditor.txt @@ -3,6 +3,9 @@ ``htmleditor`` ============== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Compose html formatted messages by default +0 - never, +1 - always, +2 - on reply to HTML message, +3 - on forward or reply to HTML message +4 - always, except when replying to plain text message diff --git a/source/administrator-guide/roundcube-settings/http_received_header.txt b/source/administrator-guide/roundcube-settings/http_received_header.txt --- a/source/administrator-guide/roundcube-settings/http_received_header.txt +++ b/source/administrator-guide/roundcube-settings/http_received_header.txt @@ -3,6 +3,4 @@ ``http_received_header`` ======================== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Add a received header to outgoing mails containing the creators IP and hostname. diff --git a/source/administrator-guide/roundcube-settings/http_received_header_encrypt.txt b/source/administrator-guide/roundcube-settings/http_received_header_encrypt.txt --- a/source/administrator-guide/roundcube-settings/http_received_header_encrypt.txt +++ b/source/administrator-guide/roundcube-settings/http_received_header_encrypt.txt @@ -3,6 +3,5 @@ ``http_received_header_encrypt`` ================================ -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Whether or not to encrypt the IP address and the host name. +These could, in some circles, be considered as sensitive information; however, for the administrator, these could be invaluable help when tracking down issues. diff --git a/source/administrator-guide/roundcube-settings/identities_level.txt b/source/administrator-guide/roundcube-settings/identities_level.txt --- a/source/administrator-guide/roundcube-settings/identities_level.txt +++ b/source/administrator-guide/roundcube-settings/identities_level.txt @@ -3,6 +3,10 @@ ``identities_level`` ==================== -.. include:: roundcube-settings/needs-work.txt +Set identities access level: -Sadly, this setting has not yet been documented. +0 - many identities with possibility to edit all params +1 - many identities with possibility to edit all params but not email address +2 - one identity with possibility to edit all params +3 - one identity with possibility to edit all params but not email address +4 - one identity with possibility to edit only signature diff --git a/source/administrator-guide/roundcube-settings/im_convert_path.txt b/source/administrator-guide/roundcube-settings/im_convert_path.txt --- a/source/administrator-guide/roundcube-settings/im_convert_path.txt +++ b/source/administrator-guide/roundcube-settings/im_convert_path.txt @@ -3,6 +3,4 @@ ``im_convert_path`` =================== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Path to imagemagick convert binary (if not set we'll use Imagick or GD extensions). diff --git a/source/administrator-guide/roundcube-settings/im_identify_path.txt b/source/administrator-guide/roundcube-settings/im_identify_path.txt --- a/source/administrator-guide/roundcube-settings/im_identify_path.txt +++ b/source/administrator-guide/roundcube-settings/im_identify_path.txt @@ -3,6 +3,4 @@ ``im_identify_path`` ==================== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Path to imagemagick identify binary (if not set we'll use Imagick or GD extensions) diff --git a/source/administrator-guide/roundcube-settings/image_thumbnail_size.txt b/source/administrator-guide/roundcube-settings/image_thumbnail_size.txt --- a/source/administrator-guide/roundcube-settings/image_thumbnail_size.txt +++ b/source/administrator-guide/roundcube-settings/image_thumbnail_size.txt @@ -3,6 +3,6 @@ ``image_thumbnail_size`` ======================== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Size of thumbnails from image attachments displayed below the message content. +Note: whether images are displayed at all depends on the 'inline_images' option. +Set to 0 to display images in full size. diff --git a/source/administrator-guide/roundcube-settings/imap_auth_cid.txt b/source/administrator-guide/roundcube-settings/imap_auth_cid.txt --- a/source/administrator-guide/roundcube-settings/imap_auth_cid.txt +++ b/source/administrator-guide/roundcube-settings/imap_auth_cid.txt @@ -3,6 +3,4 @@ ``imap_auth_cid`` ================= -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Optional IMAP authentication identifier to be used as authorization proxy diff --git a/source/administrator-guide/roundcube-settings/imap_auth_pw.txt b/source/administrator-guide/roundcube-settings/imap_auth_pw.txt --- a/source/administrator-guide/roundcube-settings/imap_auth_pw.txt +++ b/source/administrator-guide/roundcube-settings/imap_auth_pw.txt @@ -3,6 +3,4 @@ ``imap_auth_pw`` ================ -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Optional IMAP authentication password to be used for imap_auth_cid diff --git a/source/administrator-guide/roundcube-settings/imap_auth_type.txt b/source/administrator-guide/roundcube-settings/imap_auth_type.txt --- a/source/administrator-guide/roundcube-settings/imap_auth_type.txt +++ b/source/administrator-guide/roundcube-settings/imap_auth_type.txt @@ -3,6 +3,4 @@ ``imap_auth_type`` ================== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +IMAP AUTH type (DIGEST-MD5, CRAM-MD5, LOGIN, PLAIN or null to use best server supported) diff --git a/source/administrator-guide/roundcube-settings/imap_force_caps.txt b/source/administrator-guide/roundcube-settings/imap_force_caps.txt --- a/source/administrator-guide/roundcube-settings/imap_force_caps.txt +++ b/source/administrator-guide/roundcube-settings/imap_force_caps.txt @@ -3,6 +3,5 @@ ``imap_force_caps`` =================== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +By default IMAP capabilities are readed after connection to IMAP server +In some cases, e.g. when using IMAP proxy, there's a need to refresh the list after login. Set to True if you've got this case. diff --git a/source/administrator-guide/roundcube-settings/imap_force_ns.txt b/source/administrator-guide/roundcube-settings/imap_force_ns.txt --- a/source/administrator-guide/roundcube-settings/imap_force_ns.txt +++ b/source/administrator-guide/roundcube-settings/imap_force_ns.txt @@ -3,6 +3,5 @@ ``imap_force_ns`` ================= -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Some server configurations (e.g. Courier) doesn't list folders in all namespaces +Enable this option to force listing of folders in all namespaces diff --git a/source/administrator-guide/roundcube-settings/imap_timeout.txt b/source/administrator-guide/roundcube-settings/imap_timeout.txt --- a/source/administrator-guide/roundcube-settings/imap_timeout.txt +++ b/source/administrator-guide/roundcube-settings/imap_timeout.txt @@ -3,6 +3,4 @@ ``imap_timeout`` ================ -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +IMAP connection timeout, in seconds. Default: 0 (use default_socket_timeout) diff --git a/source/administrator-guide/roundcube-settings/include_host_config.txt b/source/administrator-guide/roundcube-settings/include_host_config.txt --- a/source/administrator-guide/roundcube-settings/include_host_config.txt +++ b/source/administrator-guide/roundcube-settings/include_host_config.txt @@ -3,6 +3,5 @@ ``include_host_config`` ======================= -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Try to load host-specific configuration. +See http://trac.roundcube.net/wiki/Howto_Config for more details. diff --git a/source/administrator-guide/roundcube-settings/inline_images.txt b/source/administrator-guide/roundcube-settings/inline_images.txt --- a/source/administrator-guide/roundcube-settings/inline_images.txt +++ b/source/administrator-guide/roundcube-settings/inline_images.txt @@ -3,6 +3,4 @@ ``inline_images`` ================= -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Display attached images below the message body. diff --git a/source/administrator-guide/roundcube-settings/ldap_cache.txt b/source/administrator-guide/roundcube-settings/ldap_cache.txt --- a/source/administrator-guide/roundcube-settings/ldap_cache.txt +++ b/source/administrator-guide/roundcube-settings/ldap_cache.txt @@ -3,6 +3,4 @@ ``ldap_cache`` ============== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Type of LDAP cache. Supported values: 'db', 'apc' and 'memcache'. diff --git a/source/administrator-guide/roundcube-settings/ldap_cache_ttl.txt b/source/administrator-guide/roundcube-settings/ldap_cache_ttl.txt --- a/source/administrator-guide/roundcube-settings/ldap_cache_ttl.txt +++ b/source/administrator-guide/roundcube-settings/ldap_cache_ttl.txt @@ -3,6 +3,4 @@ ``ldap_cache_ttl`` ================== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Lifetime of LDAP cache. Possible units: s, m, h, d, w diff --git a/source/administrator-guide/roundcube-settings/ldap_debug.txt b/source/administrator-guide/roundcube-settings/ldap_debug.txt --- a/source/administrator-guide/roundcube-settings/ldap_debug.txt +++ b/source/administrator-guide/roundcube-settings/ldap_debug.txt @@ -3,6 +3,4 @@ ``ldap_debug`` ============== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Log LDAP conversation to /ldap or to syslog. diff --git a/source/administrator-guide/roundcube-settings/list_cols.txt b/source/administrator-guide/roundcube-settings/list_cols.txt --- a/source/administrator-guide/roundcube-settings/list_cols.txt +++ b/source/administrator-guide/roundcube-settings/list_cols.txt @@ -3,6 +3,5 @@ ``list_cols`` ============= -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +These cols are shown in the message list. Available cols are: +subject, from, to, fromto, cc, replyto, date, size, status, flag, attachment, 'priority' diff --git a/source/administrator-guide/roundcube-settings/log_date_format.txt b/source/administrator-guide/roundcube-settings/log_date_format.txt --- a/source/administrator-guide/roundcube-settings/log_date_format.txt +++ b/source/administrator-guide/roundcube-settings/log_date_format.txt @@ -3,6 +3,5 @@ ``log_date_format`` =================== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +date format for log entries +(read http://php.net/manual/en/function.date.php for all format characters) diff --git a/source/administrator-guide/roundcube-settings/log_dir.txt b/source/administrator-guide/roundcube-settings/log_dir.txt --- a/source/administrator-guide/roundcube-settings/log_dir.txt +++ b/source/administrator-guide/roundcube-settings/log_dir.txt @@ -3,6 +3,5 @@ ``log_dir`` =========== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Activate this option if logs should be written to per-user directories. +Data will only be logged if a directry // exists and is writable. diff --git a/source/administrator-guide/roundcube-settings/log_driver.txt b/source/administrator-guide/roundcube-settings/log_driver.txt --- a/source/administrator-guide/roundcube-settings/log_driver.txt +++ b/source/administrator-guide/roundcube-settings/log_driver.txt @@ -3,6 +3,4 @@ ``log_driver`` ============== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +log driver: 'syslog' or 'file'. diff --git a/source/administrator-guide/roundcube-settings/log_logins.txt b/source/administrator-guide/roundcube-settings/log_logins.txt --- a/source/administrator-guide/roundcube-settings/log_logins.txt +++ b/source/administrator-guide/roundcube-settings/log_logins.txt @@ -3,6 +3,4 @@ ``log_logins`` ============== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Log successful/failed logins to /userlogins or to syslog diff --git a/source/administrator-guide/roundcube-settings/log_session.txt b/source/administrator-guide/roundcube-settings/log_session.txt --- a/source/administrator-guide/roundcube-settings/log_session.txt +++ b/source/administrator-guide/roundcube-settings/log_session.txt @@ -3,6 +3,4 @@ ``log_session`` =============== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Log session authentication errors to /session or to syslog diff --git a/source/administrator-guide/roundcube-settings/mail_domain.txt b/source/administrator-guide/roundcube-settings/mail_domain.txt --- a/source/administrator-guide/roundcube-settings/mail_domain.txt +++ b/source/administrator-guide/roundcube-settings/mail_domain.txt @@ -3,6 +3,13 @@ ``mail_domain`` =============== -.. include:: roundcube-settings/needs-work.txt +This domain will be used to form e-mail addresses of new users +Specify an array with 'host' => 'domain' values to support multiple hosts +Supported replacement variables: -Sadly, this setting has not yet been documented. +- %h - user's IMAP hostname +- %n - http hostname ($_SERVER['SERVER_NAME']) +- %d - domain (http hostname without the first part) +- %z - IMAP domain (IMAP hostname without the first part) + +For example %n = mail.domain.tld, %t = domain.tld diff --git a/source/administrator-guide/roundcube-settings/mail_header_delimiter.txt b/source/administrator-guide/roundcube-settings/mail_header_delimiter.txt --- a/source/administrator-guide/roundcube-settings/mail_header_delimiter.txt +++ b/source/administrator-guide/roundcube-settings/mail_header_delimiter.txt @@ -3,6 +3,5 @@ ``mail_header_delimiter`` ========================= -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +This string is used as a delimiter for message headers when sending a message via mail() function. +Leave empty for auto-detection. diff --git a/source/administrator-guide/roundcube-settings/max_group_members.txt b/source/administrator-guide/roundcube-settings/max_group_members.txt --- a/source/administrator-guide/roundcube-settings/max_group_members.txt +++ b/source/administrator-guide/roundcube-settings/max_group_members.txt @@ -3,6 +3,5 @@ ``max_group_members`` ===================== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Maximum allowed number of members of an address group. Default: 0 (no limit). +If 'max_recipients' is set this value should be less or equal. diff --git a/source/administrator-guide/roundcube-settings/max_pagesize.txt b/source/administrator-guide/roundcube-settings/max_pagesize.txt --- a/source/administrator-guide/roundcube-settings/max_pagesize.txt +++ b/source/administrator-guide/roundcube-settings/max_pagesize.txt @@ -3,6 +3,4 @@ ``max_pagesize`` ================ -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Don't let users set pagesize to more than this value if set. diff --git a/source/administrator-guide/roundcube-settings/max_recipients.txt b/source/administrator-guide/roundcube-settings/max_recipients.txt --- a/source/administrator-guide/roundcube-settings/max_recipients.txt +++ b/source/administrator-guide/roundcube-settings/max_recipients.txt @@ -3,6 +3,4 @@ ``max_recipients`` ================== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Maximum number of recipients per message. Default: 0 (no limit). diff --git a/source/administrator-guide/roundcube-settings/mdn_default.txt b/source/administrator-guide/roundcube-settings/mdn_default.txt --- a/source/administrator-guide/roundcube-settings/mdn_default.txt +++ b/source/administrator-guide/roundcube-settings/mdn_default.txt @@ -3,6 +3,4 @@ ``mdn_default`` =============== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Return receipt checkbox default state diff --git a/source/administrator-guide/roundcube-settings/mdn_requests.txt b/source/administrator-guide/roundcube-settings/mdn_requests.txt --- a/source/administrator-guide/roundcube-settings/mdn_requests.txt +++ b/source/administrator-guide/roundcube-settings/mdn_requests.txt @@ -3,6 +3,10 @@ ``mdn_requests`` ================ -.. include:: roundcube-settings/needs-work.txt +Behavior if a received message requests a message delivery notification (read receipt): -Sadly, this setting has not yet been documented. +0 = ask the user +1 = send automatically +2 = ignore (never send or ask) +3 = send automatically if sender is in addressbook, otherwise ask the user +4 = send automatically if sender is in addressbook, otherwise ignore diff --git a/source/administrator-guide/roundcube-settings/mdn_use_from.txt b/source/administrator-guide/roundcube-settings/mdn_use_from.txt --- a/source/administrator-guide/roundcube-settings/mdn_use_from.txt +++ b/source/administrator-guide/roundcube-settings/mdn_use_from.txt @@ -3,6 +3,5 @@ ``mdn_use_from`` ================ -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +According to RFC2298, return receipt envelope sender address must be empty. +If this option is true, Roundcube will use user's identity as envelope sender for MDN responses. diff --git a/source/administrator-guide/roundcube-settings/message_extwin.txt b/source/administrator-guide/roundcube-settings/message_extwin.txt --- a/source/administrator-guide/roundcube-settings/message_extwin.txt +++ b/source/administrator-guide/roundcube-settings/message_extwin.txt @@ -3,6 +3,4 @@ ``message_extwin`` ================== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Open messages in a new window. diff --git a/source/administrator-guide/roundcube-settings/message_show_email.txt b/source/administrator-guide/roundcube-settings/message_show_email.txt --- a/source/administrator-guide/roundcube-settings/message_show_email.txt +++ b/source/administrator-guide/roundcube-settings/message_show_email.txt @@ -3,6 +3,4 @@ ``message_show_email`` ====================== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Enables display of email address with name instead of a name (and address in title). diff --git a/source/administrator-guide/roundcube-settings/message_sort_col.txt b/source/administrator-guide/roundcube-settings/message_sort_col.txt --- a/source/administrator-guide/roundcube-settings/message_sort_col.txt +++ b/source/administrator-guide/roundcube-settings/message_sort_col.txt @@ -3,6 +3,5 @@ ``message_sort_col`` ==================== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Default messages sort column. Use empty value for default server's sorting, +or 'arrival', 'date', 'subject', 'from', 'to', 'fromto', 'size', 'cc' diff --git a/source/administrator-guide/roundcube-settings/message_sort_order.txt b/source/administrator-guide/roundcube-settings/message_sort_order.txt --- a/source/administrator-guide/roundcube-settings/message_sort_order.txt +++ b/source/administrator-guide/roundcube-settings/message_sort_order.txt @@ -3,6 +3,4 @@ ``message_sort_order`` ====================== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Default messages sort order. diff --git a/source/administrator-guide/roundcube-settings/mime_magic.txt b/source/administrator-guide/roundcube-settings/mime_magic.txt --- a/source/administrator-guide/roundcube-settings/mime_magic.txt +++ b/source/administrator-guide/roundcube-settings/mime_magic.txt @@ -3,6 +3,5 @@ ``mime_magic`` ============== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Path to a local mime magic database file for PHPs finfo extension. +Set to null if the default path should be used. diff --git a/source/administrator-guide/roundcube-settings/mime_param_folding.txt b/source/administrator-guide/roundcube-settings/mime_param_folding.txt --- a/source/administrator-guide/roundcube-settings/mime_param_folding.txt +++ b/source/administrator-guide/roundcube-settings/mime_param_folding.txt @@ -3,6 +3,8 @@ ``mime_param_folding`` ====================== -.. include:: roundcube-settings/needs-work.txt +Encoding of long/non-ascii attachment names: -Sadly, this setting has not yet been documented. +0 - Full RFC 2231 compatible +1 - RFC 2047 for 'name' and RFC 2231 for 'filename' parameter (Thunderbird's default) +2 - Full 2047 compatible diff --git a/source/administrator-guide/roundcube-settings/mime_types.txt b/source/administrator-guide/roundcube-settings/mime_types.txt --- a/source/administrator-guide/roundcube-settings/mime_types.txt +++ b/source/administrator-guide/roundcube-settings/mime_types.txt @@ -3,6 +3,6 @@ ``mime_types`` ============== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Absolute path to a local mime.types mapping table file. +This is used to derive mime-types from the filename extension or vice versa. +Such a file is usually part of the apache webserver. If you don't find a file named mime.types on your system, download it from http://svn.apache.org/repos/asf/httpd/httpd/trunk/docs/conf/mime.types diff --git a/source/administrator-guide/roundcube-settings/min_refresh_interval.txt b/source/administrator-guide/roundcube-settings/min_refresh_interval.txt --- a/source/administrator-guide/roundcube-settings/min_refresh_interval.txt +++ b/source/administrator-guide/roundcube-settings/min_refresh_interval.txt @@ -3,6 +3,4 @@ ``min_refresh_interval`` ======================== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Minimal value of user's 'refresh_interval' setting (in seconds) diff --git a/source/administrator-guide/roundcube-settings/no_save_sent_messages.txt b/source/administrator-guide/roundcube-settings/no_save_sent_messages.txt --- a/source/administrator-guide/roundcube-settings/no_save_sent_messages.txt +++ b/source/administrator-guide/roundcube-settings/no_save_sent_messages.txt @@ -3,6 +3,5 @@ ``no_save_sent_messages`` ========================= -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Disables saving sent messages in Sent folder (like gmail) (Default: false) +Note: useful when SMTP server stores sent mail in user mailbox diff --git a/source/administrator-guide/roundcube-settings/password_charset.txt b/source/administrator-guide/roundcube-settings/password_charset.txt --- a/source/administrator-guide/roundcube-settings/password_charset.txt +++ b/source/administrator-guide/roundcube-settings/password_charset.txt @@ -3,6 +3,7 @@ ``password_charset`` ==================== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Password character set. +If your authentication backend supports it, use "UTF-8". +Otherwise, use the appropriate character set. +Defaults to ISO-8859-1 for backward compatibility diff --git a/source/administrator-guide/roundcube-settings/plugins.txt b/source/administrator-guide/roundcube-settings/plugins.txt --- a/source/administrator-guide/roundcube-settings/plugins.txt +++ b/source/administrator-guide/roundcube-settings/plugins.txt @@ -3,6 +3,4 @@ ``plugins`` =========== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +List of active plugins (in plugins/ directory). diff --git a/source/administrator-guide/roundcube-settings/prefer_html.txt b/source/administrator-guide/roundcube-settings/prefer_html.txt --- a/source/administrator-guide/roundcube-settings/prefer_html.txt +++ b/source/administrator-guide/roundcube-settings/prefer_html.txt @@ -3,6 +3,4 @@ ``prefer_html`` =============== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Prefer displaying HTML messages. diff --git a/source/administrator-guide/roundcube-settings/prettydate.txt b/source/administrator-guide/roundcube-settings/prettydate.txt --- a/source/administrator-guide/roundcube-settings/prettydate.txt +++ b/source/administrator-guide/roundcube-settings/prettydate.txt @@ -3,6 +3,4 @@ ``prettydate`` ============== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Show pretty dates as standard. diff --git a/source/administrator-guide/roundcube-settings/preview_pane.txt b/source/administrator-guide/roundcube-settings/preview_pane.txt --- a/source/administrator-guide/roundcube-settings/preview_pane.txt +++ b/source/administrator-guide/roundcube-settings/preview_pane.txt @@ -3,6 +3,5 @@ ``preview_pane`` ================ -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Mark as read when viewed in preview pane (delay in seconds). +Set to -1 if messages in preview pane should not be marked as read. diff --git a/source/administrator-guide/roundcube-settings/preview_pane_mark_read.txt b/source/administrator-guide/roundcube-settings/preview_pane_mark_read.txt --- a/source/administrator-guide/roundcube-settings/preview_pane_mark_read.txt +++ b/source/administrator-guide/roundcube-settings/preview_pane_mark_read.txt @@ -3,6 +3,5 @@ ``preview_pane_mark_read`` ========================== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Mark as read when viewed in preview pane (delay in seconds). +Set to -1 if messages in preview pane should not be marked as read. diff --git a/source/administrator-guide/roundcube-settings/product_name.txt b/source/administrator-guide/roundcube-settings/product_name.txt --- a/source/administrator-guide/roundcube-settings/product_name.txt +++ b/source/administrator-guide/roundcube-settings/product_name.txt @@ -3,6 +3,4 @@ ``product_name`` ================ -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Name your service. This is displayed on the login screen and in the window title. diff --git a/source/administrator-guide/roundcube-settings/protect_default_folders.txt b/source/administrator-guide/roundcube-settings/protect_default_folders.txt --- a/source/administrator-guide/roundcube-settings/protect_default_folders.txt +++ b/source/administrator-guide/roundcube-settings/protect_default_folders.txt @@ -6,9 +6,6 @@ Protect the configured :ref:`admin_roundcube-settings_create_default_folders` from being unsubscribed. -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. .. seealso:: diff --git a/source/administrator-guide/roundcube-settings/quota_zero_as_unlimited.txt b/source/administrator-guide/roundcube-settings/quota_zero_as_unlimited.txt --- a/source/administrator-guide/roundcube-settings/quota_zero_as_unlimited.txt +++ b/source/administrator-guide/roundcube-settings/quota_zero_as_unlimited.txt @@ -3,6 +3,4 @@ ``quota_zero_as_unlimited`` =========================== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +if in your system 0 quota means no limit set this option to true diff --git a/source/administrator-guide/roundcube-settings/read_when_deleted.txt b/source/administrator-guide/roundcube-settings/read_when_deleted.txt --- a/source/administrator-guide/roundcube-settings/read_when_deleted.txt +++ b/source/administrator-guide/roundcube-settings/read_when_deleted.txt @@ -3,6 +3,5 @@ ``read_when_deleted`` ===================== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Set true to Mark deleted messages as read as well as deleted. +False means that a message's read status is not affected by marking it as deleted. diff --git a/source/administrator-guide/roundcube-settings/recipients_separator.txt b/source/administrator-guide/roundcube-settings/recipients_separator.txt --- a/source/administrator-guide/roundcube-settings/recipients_separator.txt +++ b/source/administrator-guide/roundcube-settings/recipients_separator.txt @@ -3,6 +3,4 @@ ``recipients_separator`` ======================== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Use this char/string to separate recipients when composing a new message. diff --git a/source/administrator-guide/roundcube-settings/referer_check.txt b/source/administrator-guide/roundcube-settings/referer_check.txt --- a/source/administrator-guide/roundcube-settings/referer_check.txt +++ b/source/administrator-guide/roundcube-settings/referer_check.txt @@ -3,6 +3,4 @@ ``referer_check`` ================= -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +check referer of incoming requests diff --git a/source/administrator-guide/roundcube-settings/refresh_interval.txt b/source/administrator-guide/roundcube-settings/refresh_interval.txt --- a/source/administrator-guide/roundcube-settings/refresh_interval.txt +++ b/source/administrator-guide/roundcube-settings/refresh_interval.txt @@ -3,6 +3,6 @@ ``refresh_interval`` ==================== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Default interval for auto-refresh requests (in seconds) +These are requests for system state updates e.g. checking for new messages, etc. +Setting it to 0 disables the feature. diff --git a/source/administrator-guide/roundcube-settings/reply_all_mode.txt b/source/administrator-guide/roundcube-settings/reply_all_mode.txt --- a/source/administrator-guide/roundcube-settings/reply_all_mode.txt +++ b/source/administrator-guide/roundcube-settings/reply_all_mode.txt @@ -3,6 +3,6 @@ ``reply_all_mode`` ================== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Default behavior of Reply-All button: +0 - Reply-All always +1 - Reply-List if mailing list is detected diff --git a/source/administrator-guide/roundcube-settings/reply_mode.txt b/source/administrator-guide/roundcube-settings/reply_mode.txt --- a/source/administrator-guide/roundcube-settings/reply_mode.txt +++ b/source/administrator-guide/roundcube-settings/reply_mode.txt @@ -3,6 +3,7 @@ ``reply_mode`` ============== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +When replying: +-1 - don't cite the original message +0 - place cursor below the original message +1 - place cursor above original message (top posting) diff --git a/source/administrator-guide/roundcube-settings/reply_same_folder.txt b/source/administrator-guide/roundcube-settings/reply_same_folder.txt --- a/source/administrator-guide/roundcube-settings/reply_same_folder.txt +++ b/source/administrator-guide/roundcube-settings/reply_same_folder.txt @@ -3,9 +3,7 @@ ``reply_same_folder`` ===================== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Place replies in the folder of the message being replied to. .. seealso:: diff --git a/source/administrator-guide/roundcube-settings/search_mods.txt b/source/administrator-guide/roundcube-settings/search_mods.txt --- a/source/administrator-guide/roundcube-settings/search_mods.txt +++ b/source/administrator-guide/roundcube-settings/search_mods.txt @@ -3,6 +3,7 @@ ``search_mods`` =============== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Defaults of the search field configuration. +The array can contain a per-folder list of header fields which should be considered when searching. +The entry with key '*' stands for all folders which do not have a specific list set. +Please note that folder names should to be in sync with $config['*_mbox'] options. diff --git a/source/administrator-guide/roundcube-settings/send_format_flowed.txt b/source/administrator-guide/roundcube-settings/send_format_flowed.txt --- a/source/administrator-guide/roundcube-settings/send_format_flowed.txt +++ b/source/administrator-guide/roundcube-settings/send_format_flowed.txt @@ -3,6 +3,4 @@ ``send_format_flowed`` ====================== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Send plaintext messages as format=flowed. diff --git a/source/administrator-guide/roundcube-settings/sendmail_delay.txt b/source/administrator-guide/roundcube-settings/sendmail_delay.txt --- a/source/administrator-guide/roundcube-settings/sendmail_delay.txt +++ b/source/administrator-guide/roundcube-settings/sendmail_delay.txt @@ -3,6 +3,4 @@ ``sendmail_delay`` ================== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +How many seconds must pass between emails sent by a user. diff --git a/source/administrator-guide/roundcube-settings/sent_mbox.txt b/source/administrator-guide/roundcube-settings/sent_mbox.txt --- a/source/administrator-guide/roundcube-settings/sent_mbox.txt +++ b/source/administrator-guide/roundcube-settings/sent_mbox.txt @@ -3,9 +3,9 @@ ``sent_mbox`` ============= -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Store sent message is this mailbox. +Leave blank if sent messages should not be stored. +NOTE: Use folder names with namespace prefix (INBOX. on Courier-IMAP) .. seealso:: diff --git a/source/administrator-guide/roundcube-settings/session_auth_name.txt b/source/administrator-guide/roundcube-settings/session_auth_name.txt --- a/source/administrator-guide/roundcube-settings/session_auth_name.txt +++ b/source/administrator-guide/roundcube-settings/session_auth_name.txt @@ -3,6 +3,4 @@ ``session_auth_name`` ===================== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Session authentication cookie name. Default: 'roundcube_sessauth' diff --git a/source/administrator-guide/roundcube-settings/session_domain.txt b/source/administrator-guide/roundcube-settings/session_domain.txt --- a/source/administrator-guide/roundcube-settings/session_domain.txt +++ b/source/administrator-guide/roundcube-settings/session_domain.txt @@ -3,6 +3,4 @@ ``session_domain`` ================== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Session domain: .example.org diff --git a/source/administrator-guide/roundcube-settings/session_lifetime.txt b/source/administrator-guide/roundcube-settings/session_lifetime.txt --- a/source/administrator-guide/roundcube-settings/session_lifetime.txt +++ b/source/administrator-guide/roundcube-settings/session_lifetime.txt @@ -3,6 +3,4 @@ ``session_lifetime`` ==================== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Session lifetime in minutes diff --git a/source/administrator-guide/roundcube-settings/session_path.txt b/source/administrator-guide/roundcube-settings/session_path.txt --- a/source/administrator-guide/roundcube-settings/session_path.txt +++ b/source/administrator-guide/roundcube-settings/session_path.txt @@ -3,6 +3,4 @@ ``session_path`` ================ -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Session path. Defaults to PHP session.cookie_path setting. diff --git a/source/administrator-guide/roundcube-settings/session_storage.txt b/source/administrator-guide/roundcube-settings/session_storage.txt --- a/source/administrator-guide/roundcube-settings/session_storage.txt +++ b/source/administrator-guide/roundcube-settings/session_storage.txt @@ -3,6 +3,12 @@ ``session_storage`` =================== -.. include:: roundcube-settings/needs-work.txt +Backend to use for session storage. Can either be 'db' (default), 'redis', 'memcache', or 'php' -Sadly, this setting has not yet been documented. +If set to 'memcache', a list of servers need to be specified in 'memcache_hosts'. +Make sure the Memcache extension (http://pecl.php.net/package/memcache) version >= 2.0.0 is installed. + +If set to 'redis', a server needs to be specified in 'redis_hosts' +Make sure the Redis extension (http://pecl.php.net/package/redis) version >= 2.0.0 is installed. + +Setting this value to 'php' will use the default session save handler configured in PHP. diff --git a/source/administrator-guide/roundcube-settings/show_images.txt b/source/administrator-guide/roundcube-settings/show_images.txt --- a/source/administrator-guide/roundcube-settings/show_images.txt +++ b/source/administrator-guide/roundcube-settings/show_images.txt @@ -3,6 +3,8 @@ ``show_images`` =============== -.. include:: roundcube-settings/needs-work.txt +Display remote inline images: -Sadly, this setting has not yet been documented. +0 - Never, always ask +1 - Ask if sender is not in address book +2 - Always show inline images diff --git a/source/administrator-guide/roundcube-settings/show_real_foldernames.txt b/source/administrator-guide/roundcube-settings/show_real_foldernames.txt --- a/source/administrator-guide/roundcube-settings/show_real_foldernames.txt +++ b/source/administrator-guide/roundcube-settings/show_real_foldernames.txt @@ -3,6 +3,4 @@ ``show_real_foldernames`` ========================= -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Disable localization of the default folder names listed above. diff --git a/source/administrator-guide/roundcube-settings/show_sig.txt b/source/administrator-guide/roundcube-settings/show_sig.txt --- a/source/administrator-guide/roundcube-settings/show_sig.txt +++ b/source/administrator-guide/roundcube-settings/show_sig.txt @@ -3,6 +3,9 @@ ``show_sig`` ============ -.. include:: roundcube-settings/needs-work.txt +Show signature: -Sadly, this setting has not yet been documented. +0 - Never +1 - Always +2 - New messages only +3 - Forwards and Replies only diff --git a/source/administrator-guide/roundcube-settings/skin.txt b/source/administrator-guide/roundcube-settings/skin.txt --- a/source/administrator-guide/roundcube-settings/skin.txt +++ b/source/administrator-guide/roundcube-settings/skin.txt @@ -3,6 +3,4 @@ ``skin`` ======== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Skin name: Name of the folder relative to skins/ diff --git a/source/administrator-guide/roundcube-settings/skin_include_php.txt b/source/administrator-guide/roundcube-settings/skin_include_php.txt --- a/source/administrator-guide/roundcube-settings/skin_include_php.txt +++ b/source/administrator-guide/roundcube-settings/skin_include_php.txt @@ -3,6 +3,4 @@ ``skin_include_php`` ==================== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Includes should be interpreted as PHP files diff --git a/source/administrator-guide/roundcube-settings/skin_logo.txt b/source/administrator-guide/roundcube-settings/skin_logo.txt --- a/source/administrator-guide/roundcube-settings/skin_logo.txt +++ b/source/administrator-guide/roundcube-settings/skin_logo.txt @@ -3,6 +3,7 @@ ``skin_logo`` ============= -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Replace the Roundcube logo with this image. +Specify a URL relative to the document root of this Roundcube installation. +An array can be used to specify different logos for specific template files, '*' for default logo. +For example array("*" => "/images/roundcube_logo.png", "messageprint" => "/images/roundcube_logo_print.png") diff --git a/source/administrator-guide/roundcube-settings/skip_deleted.txt b/source/administrator-guide/roundcube-settings/skip_deleted.txt --- a/source/administrator-guide/roundcube-settings/skip_deleted.txt +++ b/source/administrator-guide/roundcube-settings/skip_deleted.txt @@ -3,6 +3,5 @@ ``skip_deleted`` ================ -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Set true if deleted messages should not be displayed +This will make the application run slower diff --git a/source/administrator-guide/roundcube-settings/smtp_auth_cid.txt b/source/administrator-guide/roundcube-settings/smtp_auth_cid.txt --- a/source/administrator-guide/roundcube-settings/smtp_auth_cid.txt +++ b/source/administrator-guide/roundcube-settings/smtp_auth_cid.txt @@ -3,6 +3,4 @@ ``smtp_auth_cid`` ================= -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Optional SMTP authentication identifier to be used as authorization proxy. diff --git a/source/administrator-guide/roundcube-settings/smtp_auth_type.txt b/source/administrator-guide/roundcube-settings/smtp_auth_type.txt --- a/source/administrator-guide/roundcube-settings/smtp_auth_type.txt +++ b/source/administrator-guide/roundcube-settings/smtp_auth_type.txt @@ -3,6 +3,4 @@ ``smtp_auth_type`` ================== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +SMTP AUTH type (DIGEST-MD5, CRAM-MD5, LOGIN, PLAIN or empty to use best server supported) diff --git a/source/administrator-guide/roundcube-settings/smtp_conn_options.txt b/source/administrator-guide/roundcube-settings/smtp_conn_options.txt --- a/source/administrator-guide/roundcube-settings/smtp_conn_options.txt +++ b/source/administrator-guide/roundcube-settings/smtp_conn_options.txt @@ -3,6 +3,14 @@ ``smtp_conn_options`` ===================== -.. include:: roundcube-settings/needs-work.txt +SMTP socket context options. See http://php.net/manual/en/context.ssl.php. +The example below enables server certificate validation, and +requires 'smtp_timeout' to be non zero. -Sadly, this setting has not yet been documented. +$config['smtp_conn_options'] = array( + 'ssl' => array( + 'verify_peer' => true, + 'verify_depth' => 3, + 'cafile' => '/etc/openssl/certs/ca.crt', + ), +); diff --git a/source/administrator-guide/roundcube-settings/smtp_debug.txt b/source/administrator-guide/roundcube-settings/smtp_debug.txt --- a/source/administrator-guide/roundcube-settings/smtp_debug.txt +++ b/source/administrator-guide/roundcube-settings/smtp_debug.txt @@ -3,6 +3,4 @@ ``smtp_debug`` ============== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Log SMTP conversation to /smtp or to syslog. diff --git a/source/administrator-guide/roundcube-settings/smtp_helo_host.txt b/source/administrator-guide/roundcube-settings/smtp_helo_host.txt --- a/source/administrator-guide/roundcube-settings/smtp_helo_host.txt +++ b/source/administrator-guide/roundcube-settings/smtp_helo_host.txt @@ -3,6 +3,6 @@ ``smtp_helo_host`` ================== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +SMTP HELO host. +Hostname to give to the remote server for SMTP 'HELO' or 'EHLO' messages. +Leave this blank and you will get the server variable 'server_name' or localhost if that isn't defined. diff --git a/source/administrator-guide/roundcube-settings/smtp_log.txt b/source/administrator-guide/roundcube-settings/smtp_log.txt --- a/source/administrator-guide/roundcube-settings/smtp_log.txt +++ b/source/administrator-guide/roundcube-settings/smtp_log.txt @@ -3,6 +3,4 @@ ``smtp_log`` ============ -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Log sent messages to /sendmail or to syslog diff --git a/source/administrator-guide/roundcube-settings/smtp_pass.txt b/source/administrator-guide/roundcube-settings/smtp_pass.txt --- a/source/administrator-guide/roundcube-settings/smtp_pass.txt +++ b/source/administrator-guide/roundcube-settings/smtp_pass.txt @@ -3,6 +3,4 @@ ``smtp_pass`` ============= -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +SMTP password (if required). If you use %p as the password Roundcube will use the current user's password for login. diff --git a/source/administrator-guide/roundcube-settings/smtp_port.txt b/source/administrator-guide/roundcube-settings/smtp_port.txt --- a/source/administrator-guide/roundcube-settings/smtp_port.txt +++ b/source/administrator-guide/roundcube-settings/smtp_port.txt @@ -3,6 +3,4 @@ ``smtp_port`` ============= -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +SMTP port (default is 25; use 587 for STARTTLS or 465 for the deprecated SSL over SMTP (aka SMTPS)) diff --git a/source/administrator-guide/roundcube-settings/smtp_server.txt b/source/administrator-guide/roundcube-settings/smtp_server.txt --- a/source/administrator-guide/roundcube-settings/smtp_server.txt +++ b/source/administrator-guide/roundcube-settings/smtp_server.txt @@ -3,6 +3,15 @@ ``smtp_server`` =============== -.. include:: roundcube-settings/needs-work.txt +SMTP server host (for sending mails). +To use SSL/TLS connection, enter hostname with prefix ssl:// or tls:// -Sadly, this setting has not yet been documented. +Supported replacement variables: + +%h - user's IMAP hostname +%n - hostname ($_SERVER['SERVER_NAME']) +%t - hostname without the first part +%d - domain (http hostname $_SERVER['HTTP_HOST'] without the first part) +%z - IMAP domain (IMAP hostname without the first part) + +For example %n = mail.domain.tld, %t = domain.tld diff --git a/source/administrator-guide/roundcube-settings/smtp_timeout.txt b/source/administrator-guide/roundcube-settings/smtp_timeout.txt --- a/source/administrator-guide/roundcube-settings/smtp_timeout.txt +++ b/source/administrator-guide/roundcube-settings/smtp_timeout.txt @@ -3,6 +3,5 @@ ``smtp_timeout`` ================ -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +SMTP connection timeout, in seconds. Default: 0 (use default_socket_timeout). +Note: There's a known issue where using ssl connection with timeout > 0 causes connection errors (https://bugs.php.net/bug.php?id=54511) diff --git a/source/administrator-guide/roundcube-settings/smtp_user.txt b/source/administrator-guide/roundcube-settings/smtp_user.txt --- a/source/administrator-guide/roundcube-settings/smtp_user.txt +++ b/source/administrator-guide/roundcube-settings/smtp_user.txt @@ -3,6 +3,4 @@ ``smtp_user`` ============= -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +SMTP username (if required). If you use %u as the username Roundcube will use the current username for login. diff --git a/source/administrator-guide/roundcube-settings/spellcheck_before_send.txt b/source/administrator-guide/roundcube-settings/spellcheck_before_send.txt --- a/source/administrator-guide/roundcube-settings/spellcheck_before_send.txt +++ b/source/administrator-guide/roundcube-settings/spellcheck_before_send.txt @@ -3,6 +3,4 @@ ``spellcheck_before_send`` ========================== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Enables spell checking before sending a message. diff --git a/source/administrator-guide/roundcube-settings/spellcheck_dictionary.txt b/source/administrator-guide/roundcube-settings/spellcheck_dictionary.txt --- a/source/administrator-guide/roundcube-settings/spellcheck_dictionary.txt +++ b/source/administrator-guide/roundcube-settings/spellcheck_dictionary.txt @@ -3,6 +3,5 @@ ``spellcheck_dictionary`` ========================= -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Enables spellchecker exceptions dictionary. +Setting it to 'shared' will make the dictionary shared by all users. diff --git a/source/administrator-guide/roundcube-settings/spellcheck_engine.txt b/source/administrator-guide/roundcube-settings/spellcheck_engine.txt --- a/source/administrator-guide/roundcube-settings/spellcheck_engine.txt +++ b/source/administrator-guide/roundcube-settings/spellcheck_engine.txt @@ -3,6 +3,11 @@ ``spellcheck_engine`` ===================== -.. include:: roundcube-settings/needs-work.txt +Set the spell checking engine. Possible values: -Sadly, this setting has not yet been documented. +- 'googie' - the default (also used for connecting to Nox Spell Server, see 'spellcheck_uri' setting) +- 'pspell' - requires the PHP Pspell module and aspell installed +- 'enchant' - requires the PHP Enchant module +- 'atd' - install your own After the Deadline server or check with the people at http://www.afterthedeadline.com before using their API + +Since Google shut down their public spell checking service, the default settings connect to http://spell.roundcube.net which is a hosted service provided by Roundcube. You can connect to any other googie-compliant service by setting 'spellcheck_uri' accordingly. diff --git a/source/administrator-guide/roundcube-settings/spellcheck_ignore_caps.txt b/source/administrator-guide/roundcube-settings/spellcheck_ignore_caps.txt --- a/source/administrator-guide/roundcube-settings/spellcheck_ignore_caps.txt +++ b/source/administrator-guide/roundcube-settings/spellcheck_ignore_caps.txt @@ -3,6 +3,4 @@ ``spellcheck_ignore_caps`` ========================== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Makes that words with all letters capitalized will be ignored (e.g. GOOGLE). diff --git a/source/administrator-guide/roundcube-settings/spellcheck_ignore_nums.txt b/source/administrator-guide/roundcube-settings/spellcheck_ignore_nums.txt --- a/source/administrator-guide/roundcube-settings/spellcheck_ignore_nums.txt +++ b/source/administrator-guide/roundcube-settings/spellcheck_ignore_nums.txt @@ -3,6 +3,4 @@ ``spellcheck_ignore_nums`` ========================== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Makes that words with numbers will be ignored (e.g. g00gle). diff --git a/source/administrator-guide/roundcube-settings/spellcheck_ignore_syms.txt b/source/administrator-guide/roundcube-settings/spellcheck_ignore_syms.txt --- a/source/administrator-guide/roundcube-settings/spellcheck_ignore_syms.txt +++ b/source/administrator-guide/roundcube-settings/spellcheck_ignore_syms.txt @@ -3,6 +3,4 @@ ``spellcheck_ignore_syms`` ========================== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Makes that words with symbols will be ignored (e.g. g@@gle). diff --git a/source/administrator-guide/roundcube-settings/spellcheck_languages.txt b/source/administrator-guide/roundcube-settings/spellcheck_languages.txt --- a/source/administrator-guide/roundcube-settings/spellcheck_languages.txt +++ b/source/administrator-guide/roundcube-settings/spellcheck_languages.txt @@ -3,6 +3,6 @@ ``spellcheck_languages`` ======================== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +These languages can be selected for spell checking. +Configure as a PHP style hash array: array('en'=>'English', 'de'=>'Deutsch'); +Leave empty for default set of available language. diff --git a/source/administrator-guide/roundcube-settings/spellcheck_uri.txt b/source/administrator-guide/roundcube-settings/spellcheck_uri.txt --- a/source/administrator-guide/roundcube-settings/spellcheck_uri.txt +++ b/source/administrator-guide/roundcube-settings/spellcheck_uri.txt @@ -3,6 +3,6 @@ ``spellcheck_uri`` ================== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +For locally installed Nox Spell Server or After the Deadline services, please specify the URI to call it. +Get Nox Spell Server from http://orangoo.com/labs/?page_id=72 or the After the Deadline package from http://www.afterthedeadline.com. +Leave empty to use the public API of service.afterthedeadline.com. diff --git a/source/administrator-guide/roundcube-settings/sql_debug.txt b/source/administrator-guide/roundcube-settings/sql_debug.txt --- a/source/administrator-guide/roundcube-settings/sql_debug.txt +++ b/source/administrator-guide/roundcube-settings/sql_debug.txt @@ -3,6 +3,4 @@ ``sql_debug`` ============= -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Log SQL queries to /sql or to syslog. diff --git a/source/administrator-guide/roundcube-settings/standard_windows.txt b/source/administrator-guide/roundcube-settings/standard_windows.txt --- a/source/administrator-guide/roundcube-settings/standard_windows.txt +++ b/source/administrator-guide/roundcube-settings/standard_windows.txt @@ -3,6 +3,4 @@ ``standard_windows`` ==================== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Enables using standard browser windows (that can be handled as tabs) instead of popup windows diff --git a/source/administrator-guide/roundcube-settings/strip_existing_sig.txt b/source/administrator-guide/roundcube-settings/strip_existing_sig.txt --- a/source/administrator-guide/roundcube-settings/strip_existing_sig.txt +++ b/source/administrator-guide/roundcube-settings/strip_existing_sig.txt @@ -3,6 +3,4 @@ ``strip_existing_sig`` ====================== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +When replying strip original signature from message. diff --git a/source/administrator-guide/roundcube-settings/support_url.txt b/source/administrator-guide/roundcube-settings/support_url.txt --- a/source/administrator-guide/roundcube-settings/support_url.txt +++ b/source/administrator-guide/roundcube-settings/support_url.txt @@ -3,6 +3,5 @@ ``support_url`` =============== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +provide an URL where a user can get support for this Roundcube installation. +PLEASE DO NOT LINK TO THE ROUNDCUBE.NET WEBSITE HERE! diff --git a/source/administrator-guide/roundcube-settings/syslog_facility.txt b/source/administrator-guide/roundcube-settings/syslog_facility.txt --- a/source/administrator-guide/roundcube-settings/syslog_facility.txt +++ b/source/administrator-guide/roundcube-settings/syslog_facility.txt @@ -3,6 +3,5 @@ ``syslog_facility`` =================== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Syslog facility to use, if using the 'syslog' log driver. +For possible values see installer or http://php.net/manual/en/function.openlog.php. diff --git a/source/administrator-guide/roundcube-settings/syslog_id.txt b/source/administrator-guide/roundcube-settings/syslog_id.txt --- a/source/administrator-guide/roundcube-settings/syslog_id.txt +++ b/source/administrator-guide/roundcube-settings/syslog_id.txt @@ -3,6 +3,4 @@ ``syslog_id`` ============= -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Syslog ident string to use, if using the 'syslog' log driver. diff --git a/source/administrator-guide/roundcube-settings/temp_dir.txt b/source/administrator-guide/roundcube-settings/temp_dir.txt --- a/source/administrator-guide/roundcube-settings/temp_dir.txt +++ b/source/administrator-guide/roundcube-settings/temp_dir.txt @@ -3,6 +3,4 @@ ``temp_dir`` ============ -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Use this folder to store temp files. Must be writeable for the user who runs PHP process (Apache user if mod_php is being used). diff --git a/source/administrator-guide/roundcube-settings/temp_dir_ttl.txt b/source/administrator-guide/roundcube-settings/temp_dir_ttl.txt --- a/source/administrator-guide/roundcube-settings/temp_dir_ttl.txt +++ b/source/administrator-guide/roundcube-settings/temp_dir_ttl.txt @@ -3,6 +3,4 @@ ``temp_dir_ttl`` ================ -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Expire files in temp_dir after the set time (default: 48 hours). Possible units: s, m, h, d, w diff --git a/source/administrator-guide/roundcube-settings/time_format.txt b/source/administrator-guide/roundcube-settings/time_format.txt --- a/source/administrator-guide/roundcube-settings/time_format.txt +++ b/source/administrator-guide/roundcube-settings/time_format.txt @@ -3,6 +3,4 @@ ``time_format`` =============== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Use this format for time display (date or strftime format). diff --git a/source/administrator-guide/roundcube-settings/time_formats.txt b/source/administrator-guide/roundcube-settings/time_formats.txt --- a/source/administrator-guide/roundcube-settings/time_formats.txt +++ b/source/administrator-guide/roundcube-settings/time_formats.txt @@ -3,6 +3,4 @@ ``time_formats`` ================ -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Give this choice of time formats to the user to select from. diff --git a/source/administrator-guide/roundcube-settings/timezone.txt b/source/administrator-guide/roundcube-settings/timezone.txt --- a/source/administrator-guide/roundcube-settings/timezone.txt +++ b/source/administrator-guide/roundcube-settings/timezone.txt @@ -3,6 +3,6 @@ ``timezone`` ============ -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Use this timezone to display date/time. +Valid timezone identifers are listed here: php.net/manual/en/timezones.php +'auto' will use the browser's timezone settings. diff --git a/source/administrator-guide/roundcube-settings/trash_mbox.txt b/source/administrator-guide/roundcube-settings/trash_mbox.txt --- a/source/administrator-guide/roundcube-settings/trash_mbox.txt +++ b/source/administrator-guide/roundcube-settings/trash_mbox.txt @@ -3,9 +3,9 @@ ``trash_mbox`` ============== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Move messages to this folder when deleting them. +Leave blank if they should be deleted directly. +NOTE: Use folder names with namespace prefix (INBOX. on Courier-IMAP). .. seealso:: diff --git a/source/administrator-guide/roundcube-settings/undo_timeout.txt b/source/administrator-guide/roundcube-settings/undo_timeout.txt --- a/source/administrator-guide/roundcube-settings/undo_timeout.txt +++ b/source/administrator-guide/roundcube-settings/undo_timeout.txt @@ -3,6 +3,6 @@ ``undo_timeout`` ================ -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Specifies for how many seconds the Undo button will be available after object delete action. +Currently used with supporting address book sources. +Setting it to 0, disables the feature. diff --git a/source/administrator-guide/roundcube-settings/upload_progress.txt b/source/administrator-guide/roundcube-settings/upload_progress.txt --- a/source/administrator-guide/roundcube-settings/upload_progress.txt +++ b/source/administrator-guide/roundcube-settings/upload_progress.txt @@ -3,6 +3,5 @@ ``upload_progress`` =================== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Enables files upload indicator. Requires APC installed and enabled apc.rfc1867 option. +By default refresh time is set to 1 second. You can set this value to true or any integer value indicating number of seconds. diff --git a/source/administrator-guide/roundcube-settings/use_https.txt b/source/administrator-guide/roundcube-settings/use_https.txt --- a/source/administrator-guide/roundcube-settings/use_https.txt +++ b/source/administrator-guide/roundcube-settings/use_https.txt @@ -3,6 +3,6 @@ ``use_https`` ============= -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Tell PHP that it should work as under secure connection even if it doesn't recognize it as secure ($_SERVER['HTTPS'] is not set). +e.g. when you're running Roundcube behind a https proxy. +This option is mutually exclusive to 'force_https' and only either one of them should be set to true. diff --git a/source/administrator-guide/roundcube-settings/user_aliases.txt b/source/administrator-guide/roundcube-settings/user_aliases.txt --- a/source/administrator-guide/roundcube-settings/user_aliases.txt +++ b/source/administrator-guide/roundcube-settings/user_aliases.txt @@ -3,6 +3,4 @@ ``user_aliases`` ================ -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Enables possibility to log in using email address from user identities diff --git a/source/administrator-guide/roundcube-settings/useragent.txt b/source/administrator-guide/roundcube-settings/useragent.txt --- a/source/administrator-guide/roundcube-settings/useragent.txt +++ b/source/administrator-guide/roundcube-settings/useragent.txt @@ -3,6 +3,4 @@ ``useragent`` ============= -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Add this user-agent to message headers when sending. diff --git a/source/administrator-guide/roundcube-settings/username_domain.txt b/source/administrator-guide/roundcube-settings/username_domain.txt --- a/source/administrator-guide/roundcube-settings/username_domain.txt +++ b/source/administrator-guide/roundcube-settings/username_domain.txt @@ -3,6 +3,15 @@ ``username_domain`` =================== -.. include:: roundcube-settings/needs-work.txt +Automatically add this domain to user names for login +Only for IMAP servers that require full e-mail addresses for login +Specify an array with 'host' => 'domain' values to support multiple hosts +Supported replacement variables: -Sadly, this setting has not yet been documented. +- %h - user's IMAP hostname +- %n - hostname ($_SERVER['SERVER_NAME']) +- %t - hostname without the first part +- %d - domain (http hostname $_SERVER['HTTP_HOST'] without the first part) +- %z - IMAP domain (IMAP hostname without the first part) + +For example %n = mail.domain.tld, %t = domain.tld diff --git a/source/administrator-guide/roundcube-settings/username_domain_forced.txt b/source/administrator-guide/roundcube-settings/username_domain_forced.txt --- a/source/administrator-guide/roundcube-settings/username_domain_forced.txt +++ b/source/administrator-guide/roundcube-settings/username_domain_forced.txt @@ -3,6 +3,5 @@ ``username_domain_forced`` ========================== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +Force domain configured in username_domain to be used for login. +Any domain in username will be replaced by username_domain. diff --git a/source/administrator-guide/roundcube-settings/x_frame_options.txt b/source/administrator-guide/roundcube-settings/x_frame_options.txt --- a/source/administrator-guide/roundcube-settings/x_frame_options.txt +++ b/source/administrator-guide/roundcube-settings/x_frame_options.txt @@ -3,6 +3,5 @@ ``x_frame_options`` =================== -.. include:: roundcube-settings/needs-work.txt - -Sadly, this setting has not yet been documented. +X-Frame-Options HTTP header value sent to prevent from Clickjacking. +Possible values: sameorigin|deny. Set to false in order to disable sending them.