X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;ds=inline;f=doc%2Fpresets.txt;h=54ff6e4246c9dc3c304facead8e4c01e9c93a1b3;hb=a28de4194b8f41675c0034aeabee86ab35a8c00f;hp=6b6e7f054b24be83e092987cc4c6a80ebe966edb;hpb=7d64a0e4bcedda6976b91783ee20369fe70e335a;p=squirrelmail.git diff --git a/doc/presets.txt b/doc/presets.txt index 6b6e7f05..54ff6e42 100644 --- a/doc/presets.txt +++ b/doc/presets.txt @@ -1,24 +1,28 @@ $Date$ -This file lists squirrelmail options set by D option in conf.pl +This file lists the SquirrelMail settings set by option D in conf.pl -It can be used if user can't run conf.pl and changes options manually. -Settings can be different if IMAP server uses shared folders. +These can be used if the administrator can't run conf.pl and wants to +change these settings manually. These settings can be different if +the IMAP server uses shared folders. -Possible server values are: - cyrus = Cyrus IMAP server - uw = University of Washington's IMAP server - exchange = Microsoft Exchange IMAP server - courier = Courier IMAP server - macosx = Mac OS X Mailserver - mercury32 = Mercury/32 +Possible server type values are: + bincimap = Binc IMAP server + courier = Courier IMAP server + cyrus = Cyrus IMAP server + dovecot = Dovecot Secure IMAP server + exchange = Microsoft Exchange IMAP server + hmailserver = hMailServer + macosx = Mac OS X Mailserver + mercury32 = Mercury/32 + uw = University of Washington's IMAP server ----------------- default settings: ----------------- imap_server_type = other - default_folder_prefix = + default_folder_prefix = (is set to empty string) trash_folder = INBOX.Trash sent_folder = INBOX.Sent draft_folder = INBOX.Drafts @@ -32,8 +36,12 @@ show_contain_subfolders_option = false ----------------- 'cyrus' settings: ----------------- +Server supports server side sorting since 2.0.4 version. euc-jp, euc-kr, +tis-620, cp1251, cp1255 character sets are not supported by sorting functions +(v.2.2.12). + imap_server_type = cyrus - default_folder_prefix = (is not set) + default_folder_prefix = (is set to empty string) trash_folder = INBOX.Trash sent_folder = INBOX.Sent draft_folder = INBOX.Drafts @@ -47,6 +55,8 @@ show_contain_subfolders_option = false -------------- 'uw' settings: -------------- +Server supports server side sorting. Plain text logins are disabled by default. + imap_server_type = uw default_folder_prefix = mail/ trash_folder = Trash @@ -62,8 +72,10 @@ show_contain_subfolders_option = true -------------------- 'exchange' settings: -------------------- +Server does not support server side sorting. + imap_server_type = exchange - default_folder_prefix = (is not set) + default_folder_prefix = (is set to empty string) trash_folder = INBOX/Deleted Items sent_folder = INBOX/Sent Items draft_folder = Drafts @@ -77,6 +89,12 @@ show_contain_subfolders_option = false ------------------- 'courier' settings: ------------------- +Fast, scalable, enterprise IMAP server that uses Maildirs + +Server supports server side sorting. SquirrelMail can issue IMAP commands +that are supported only when courier-imap is compiled with --enable-unicode +option. + imap_server_type = courier default_folder_prefix = INBOX. trash_folder = Trash @@ -104,18 +122,111 @@ show_contain_subfolders_option = false delete_folder = true force_username_lowercase = false -------------------- -'mercury' settings: -------------------- - imap_server_type = mercury32 - default_folder_prefix = INBOX/ +----------------------- +'hmailserver' settings: +----------------------- +Preset is used with hMailServer IMAP server. Available since SquirrelMail 1.5.1 +and 1.4.4. Open source email server for WinNT and later. + + imap_server_type = hmailserver (used in imap_search.php) + default_folder_prefix = (is set to empty string) trash_folder = INBOX.Trash sent_folder = INBOX.Sent draft_folder = INBOX.Drafts show_prefix_option = false default_sub_of_inbox = true +show_contain_subfolders_option = false + optional_delimiter = detect + delete_folder = false + force_username_lowercase = false + +--------------------- +'mercury32' settings: +--------------------- +Preset is used for Mercury Mail Transport System. Available since 1.5.0 and 1.4.6. +Free email server for Win32 and Netware. + +Comments: +* Server side sorting and threading are not supported. +* Message flags are not supported. +* IMAP folders can store messages _or_ other folders. +* Supports STARTTLS, if configured. +* May have issues with 8bit IMAP folder names. + +$imap_server_type variable is used to handle imap folder subscription +differences. + + imap_server_type = mercury32 + default_folder_prefix = (is set to empty string) + trash_folder = Trash + sent_folder = Sent + draft_folder = Drafts + show_prefix_option = false + default_sub_of_inbox = true show_contain_subfolders_option = true optional_delimiter = detect delete_folder = true force_username_lowercase = true +------------------- +'dovecot' settings: +------------------- +Preset used for Dovecot Secure IMAP server. Available since 1.5.1 and 1.4.6. + +There is no code specific to Dovecot IMAP server. Preset provides only a quick +way to set correct folder settings. Preset works with any IMAP server that does +not store IMAP folders under INBOX and IMAP folders can store messages and other +folders. Preset can also be used with Bejy IMAP server. + +IMAP server supports server side sorting and threading. + + imap_server_type = dovecot + default_folder_prefix = (is set to empty string) + trash_folder = Trash + sent_folder = Sent + draft_folder = Drafts + show_prefix_option = false + default_sub_of_inbox = false +show_contain_subfolders_option = false + optional_delimiter = detect + delete_folder = false + force_username_lowercase = true + + +-------------------- +'bincimap' settings: +-------------------- +Preset is used with Binc IMAP server. Available since 1.5.1 and 1.4.6. + +IMAP server does not support server side sorting and threading. Plain text +logins are disabled by default. Due to available storage backend configuration +options it is impossible to create single preset, which covers all setups. + +* Default (1.2.13) configuration with Maildir++ depot and / delimiter + imap_server_type = bincimap (is used to handle INBOX in folder management) + default_folder_prefix = INBOX/ + trash_folder = Trash + sent_folder = Sent + draft_folder = Drafts + show_prefix_option = false + default_sub_of_inbox = false +show_contain_subfolders_option = false + optional_delimiter = / (can be set to 'detect') + delete_folder = true + force_username_lowercase = false (depends on checkpassword) + +* Default (1.3.4) configuration with IMAPdir depot - same as dovecot ? + imap_server_type = bincimap + default_folder_prefix = (is set to empty string) + trash_folder = Trash + sent_folder = Sent + draft_folder = Drafts + show_prefix_option = false + default_sub_of_inbox = false +show_contain_subfolders_option = false + optional_delimiter = / (can be set to 'detect') + delete_folder = true + force_username_lowercase = false (depends on checkpassword) + + +* Configuration with Maildir++ depot and . delimiter - use courier preset.