X-Git-Url: https://vcs.fsf.org/?p=squirrelmail.git;a=blobdiff_plain;f=doc%2Fpresets.txt;h=5762a1298be67ec18cec7b4d4ea530685cb64b25;hp=730bb631aba54aa2424e409a9d42a91227fdfba5;hb=bd3ebe3f8f07fd1b4294a30ef0c09a641eea1e77;hpb=b39825f012b48ea8b60c3954f5f551fa9095c26b diff --git a/doc/presets.txt b/doc/presets.txt index 730bb631..5762a129 100644 --- a/doc/presets.txt +++ b/doc/presets.txt @@ -1,25 +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: +Possible server type values are: + bincimap = Binc IMAP server + courier = Courier IMAP server cyrus = Cyrus IMAP server - uw = University of Washington's IMAP server + dovecot = Dovecot Secure IMAP server exchange = Microsoft Exchange IMAP server - courier = Courier IMAP server - macosx = Mac OS X Mailserver 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 @@ -33,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 @@ -48,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 @@ -63,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 @@ -78,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 @@ -105,23 +122,171 @@ show_contain_subfolders_option = false delete_folder = true force_username_lowercase = false ------------------- +----------------------- 'hmailserver' settings: ------------------- - imap_server_type = hmailserver (used in imap_search.php) +----------------------- +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. -------------------- -'mercury' settings: -------------------- - imap_server_type = mercury32 - default_folder_prefix = INBOX/ + 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. + + +--------------------- +'gmail' settings: +--------------------- +Support for using SquirrelMail as a front end for Google Mail (Gmail) +accounts was added in SquirrelMail versions 1.4.20 and 1.5.2 and is +currently experimental. + +CAPABILITY IMAP4rev1 UNSELECT LITERAL+ IDLE NAMESPACE QUOTA ID XLIST CHILDREN +X-GM-EXT-1 UIDPLUS COMPRESS=DEFLATE + +Notes: +* Might want to remove "All Mail" from folder drop-down lists (such as the + ones for moving mail to folders... "All Mail" is not a folder in Gmail + (it is a super-folder that shows mail from all folders) +* Might want to remove the whole folder list drop-down from Create Folder + section, since labels/folders are usually just created as children of +* Might want to remove any folders prefixed with [Gmail]/ from the rename + and delete folders drop down selectors, since those are Gmail system folders +* Might want to tweak what's included in the (un)subscribe menus too(?) +* The folder list order is slightly strange, with the Gmail system folders + listed below the user labels/folders +* When a user changes languages in Gmail's interface, the Drafts, Sent and + Trash folder names are changed to localized versions thereof. To see those + folders correctly in SquirrelMail, the user should change the SquirrelMail + language to match. Moreover, SquirrelMail then needs to be told what + folders to use for Drafts, Sent and Trash in Options --> Folder Preferences. + These default settings will only correctly find the Sent, Trash and Drafts + folders if both Gmail and SquirrelMail languages are set to English. + (This could be solved with implementation of extended LIST command support.) +* In some places (Europe?), the "[Gmail]" prefix should be "[Google Mail]" + and "Trash" might be called "Bin" + + imap_server_type = gmail + default_folder_prefix = (is set to empty string) + trash_folder = [Gmail]/Trash + default_move_to_trash = true + sent_folder = [Gmail]/Sent Mail + draft_folder = [Gmail]/Drafts + auto_create_special = false + show_prefix_option = false + default_sub_of_inbox = false +show_contain_subfolders_option = false + optional_delimiter = / + delete_folder = true + force_username_lowercase = false + domain = gmail.com + imapServerAddress = imap.gmail.com + imapPort = 993 + use_imap_tls = true + imap_auth_mech = login + smtpServerAddress = smtp.gmail.com + smtpPort = 465 + use_smtp_tls = true + smtp_auth_mech = login + pop_before_smtp = false + useSendmail = false + +-------------------